From 15984f83c1f6227fbf58f781d0ae0b94e849f492 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:40:57 +0000 Subject: [PATCH 01/32] chore: update docs/dyn/index.md --- docs/dyn/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/dyn/index.md b/docs/dyn/index.md index 1ea4fc0d39..fd12464aa7 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -1168,6 +1168,7 @@ ## searchads360 * [v0](http://googleapis.github.io/google-api-python-client/docs/dyn/searchads360_v0.html) +* [v23](http://googleapis.github.io/google-api-python-client/docs/dyn/searchads360_v23.html) ## searchconsole From f2cabd6acb1a469c309998bbb96b8617a24f108e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:40:57 +0000 Subject: [PATCH 02/32] feat(agentregistry): update the api #### agentregistry:v1alpha The following keys were added: - resources.projects.resources.locations.resources.bindings.methods.create (Total Keys: 16) - resources.projects.resources.locations.resources.bindings.methods.delete (Total Keys: 13) - resources.projects.resources.locations.resources.bindings.methods.fetchAvailable (Total Keys: 20) - resources.projects.resources.locations.resources.bindings.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.bindings.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.bindings.methods.patch (Total Keys: 17) - schemas.AuthProviderBinding (Total Keys: 6) - schemas.Binding (Total Keys: 13) - schemas.FetchAvailableBindingsResponse (Total Keys: 5) - schemas.ListBindingsResponse (Total Keys: 5) - schemas.Source (Total Keys: 3) - schemas.Target (Total Keys: 3) --- ...y_v1alpha.projects.locations.bindings.html | 422 ++++++++++++++++++ ...ntregistry_v1alpha.projects.locations.html | 5 + ...v1alpha.projects.locations.mcpServers.html | 6 +- .../documents/agentregistry.v1alpha.json | 361 ++++++++++++++- 4 files changed, 789 insertions(+), 5 deletions(-) create mode 100644 docs/dyn/agentregistry_v1alpha.projects.locations.bindings.html diff --git a/docs/dyn/agentregistry_v1alpha.projects.locations.bindings.html b/docs/dyn/agentregistry_v1alpha.projects.locations.bindings.html new file mode 100644 index 0000000000..628cd896da --- /dev/null +++ b/docs/dyn/agentregistry_v1alpha.projects.locations.bindings.html @@ -0,0 +1,422 @@ + + + +

Agent Registry API . projects . locations . bindings

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new Binding in a given project and location.

+

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

+

Deletes a single Binding.

+

+ fetchAvailable(parent, pageSize=None, pageToken=None, sourceIdentifier=None, targetIdentifier=None, x__xgafv=None)

+

Fetches available Bindings.

+

+ fetchAvailable_next()

+

Retrieves the next page of results.

+

+ get(name, x__xgafv=None)

+

Gets details of a single Binding.

+

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

+

Lists Bindings in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the parameters of a single Binding.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, bindingId=None, body=None, requestId=None, x__xgafv=None) +
Creates a new Binding in a given project and location.
+
+Args:
+  parent: string, Required. The project and location to create the Binding in. Expected format: `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a user-defined Binding.
+  "authProviderBinding": { # The AuthProvider of the Binding. # The binding for AuthProvider.
+    "authProvider": "A String", # Required. The resource name of the target AuthProvider. Format: * `projects/{project}/locations/{location}/authProviders/{auth_provider}`
+    "continueUri": "A String", # Optional. The continue URI of the AuthProvider. The URI is used to reauthenticate the user and finalize the managed OAuth flow.
+    "scopes": [ # Optional. The list of OAuth2 scopes of the AuthProvider.
+      "A String",
+    ],
+  },
+  "createTime": "A String", # Output only. Timestamp when this binding was created.
+  "description": "A String", # Optional. User-defined description of a Binding. Can have a maximum length of `2048` characters.
+  "displayName": "A String", # Optional. User-defined display name for the Binding. Can have a maximum length of `63` characters.
+  "name": "A String", # Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`.
+  "source": { # The source of the Binding. # Required. The target Agent of the Binding.
+    "identifier": "A String", # The identifier of the source Agent. Format: * `urn:agent:{publisher}:{namespace}:{name}`
+  },
+  "target": { # The target of the Binding. # Required. The target Agent Registry Resource of the Binding.
+    "identifier": "A String", # The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher}:{namespace}:{name}` * `urn:mcp:{publisher}:{namespace}:{name}` * `urn:endpoint:{publisher}:{namespace}:{name}`
+  },
+  "updateTime": "A String", # Output only. Timestamp when this binding was last updated.
+}
+
+  bindingId: string, Required. The ID to use for the binding, which will become the final component of the binding's resource name. This value should be 4-63 characters, and must conform to RFC-1034. Specifically, it must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
+  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 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).
+  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, requestId=None, x__xgafv=None) +
Deletes a single Binding.
+
+Args:
+  name: string, Required. The name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`. (required)
+  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": { # 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.
+  },
+}
+
+ +
+ fetchAvailable(parent, pageSize=None, pageToken=None, sourceIdentifier=None, targetIdentifier=None, x__xgafv=None) +
Fetches available Bindings.
+
+Args:
+  parent: string, Required. The parent, in the format `projects/{project}/locations/{location}`. (required)
+  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. Page size is 500 if unspecified and is capped at `500` even if a larger value is given.
+  pageToken: string, Optional. A token identifying a page of results the server should return.
+  sourceIdentifier: string, The identifier of the source Agent. Format: * `urn:agent:{publisher}:{namespace}:{name}`
+  targetIdentifier: string, Optional. The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher}:{namespace}:{name}` * `urn:mcp:{publisher}:{namespace}:{name}` * `urn:endpoint:{publisher}:{namespace}:{name}`
+  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 fetching available Bindings.
+  "bindings": [ # The list of Bindings.
+    { # Represents a user-defined Binding.
+      "authProviderBinding": { # The AuthProvider of the Binding. # The binding for AuthProvider.
+        "authProvider": "A String", # Required. The resource name of the target AuthProvider. Format: * `projects/{project}/locations/{location}/authProviders/{auth_provider}`
+        "continueUri": "A String", # Optional. The continue URI of the AuthProvider. The URI is used to reauthenticate the user and finalize the managed OAuth flow.
+        "scopes": [ # Optional. The list of OAuth2 scopes of the AuthProvider.
+          "A String",
+        ],
+      },
+      "createTime": "A String", # Output only. Timestamp when this binding was created.
+      "description": "A String", # Optional. User-defined description of a Binding. Can have a maximum length of `2048` characters.
+      "displayName": "A String", # Optional. User-defined display name for the Binding. Can have a maximum length of `63` characters.
+      "name": "A String", # Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`.
+      "source": { # The source of the Binding. # Required. The target Agent of the Binding.
+        "identifier": "A String", # The identifier of the source Agent. Format: * `urn:agent:{publisher}:{namespace}:{name}`
+      },
+      "target": { # The target of the Binding. # Required. The target Agent Registry Resource of the Binding.
+        "identifier": "A String", # The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher}:{namespace}:{name}` * `urn:mcp:{publisher}:{namespace}:{name}` * `urn:endpoint:{publisher}:{namespace}:{name}`
+      },
+      "updateTime": "A String", # Output only. Timestamp when this binding was last updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+}
+
+ +
+ fetchAvailable_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.
+        
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single Binding.
+
+Args:
+  name: string, Required. The name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`. (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 user-defined Binding.
+  "authProviderBinding": { # The AuthProvider of the Binding. # The binding for AuthProvider.
+    "authProvider": "A String", # Required. The resource name of the target AuthProvider. Format: * `projects/{project}/locations/{location}/authProviders/{auth_provider}`
+    "continueUri": "A String", # Optional. The continue URI of the AuthProvider. The URI is used to reauthenticate the user and finalize the managed OAuth flow.
+    "scopes": [ # Optional. The list of OAuth2 scopes of the AuthProvider.
+      "A String",
+    ],
+  },
+  "createTime": "A String", # Output only. Timestamp when this binding was created.
+  "description": "A String", # Optional. User-defined description of a Binding. Can have a maximum length of `2048` characters.
+  "displayName": "A String", # Optional. User-defined display name for the Binding. Can have a maximum length of `63` characters.
+  "name": "A String", # Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`.
+  "source": { # The source of the Binding. # Required. The target Agent of the Binding.
+    "identifier": "A String", # The identifier of the source Agent. Format: * `urn:agent:{publisher}:{namespace}:{name}`
+  },
+  "target": { # The target of the Binding. # Required. The target Agent Registry Resource of the Binding.
+    "identifier": "A String", # The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher}:{namespace}:{name}` * `urn:mcp:{publisher}:{namespace}:{name}` * `urn:endpoint:{publisher}:{namespace}:{name}`
+  },
+  "updateTime": "A String", # Output only. Timestamp when this binding was last updated.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Bindings in a given project and location.
+
+Args:
+  parent: string, Required. The project and location to list bindings in. Expected format: `projects/{project}/locations/{location}`. (required)
+  filter: string, Optional. A query string used to filter the list of bindings returned. The filter expression must follow AIP-160 syntax.
+  orderBy: string, Optional. Hint for how to order the results
+  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. Page size is 500 if unspecified and is capped at `500` even if a larger value is given.
+  pageToken: string, Optional. A token identifying a page of results the server should return.
+  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 Bindings
+  "bindings": [ # The list of Binding resources matching the parent and filter criteria in the request. Each Binding resource follows the format: `projects/{project}/locations/{location}/bindings/{binding}`.
+    { # Represents a user-defined Binding.
+      "authProviderBinding": { # The AuthProvider of the Binding. # The binding for AuthProvider.
+        "authProvider": "A String", # Required. The resource name of the target AuthProvider. Format: * `projects/{project}/locations/{location}/authProviders/{auth_provider}`
+        "continueUri": "A String", # Optional. The continue URI of the AuthProvider. The URI is used to reauthenticate the user and finalize the managed OAuth flow.
+        "scopes": [ # Optional. The list of OAuth2 scopes of the AuthProvider.
+          "A String",
+        ],
+      },
+      "createTime": "A String", # Output only. Timestamp when this binding was created.
+      "description": "A String", # Optional. User-defined description of a Binding. Can have a maximum length of `2048` characters.
+      "displayName": "A String", # Optional. User-defined display name for the Binding. Can have a maximum length of `63` characters.
+      "name": "A String", # Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`.
+      "source": { # The source of the Binding. # Required. The target Agent of the Binding.
+        "identifier": "A String", # The identifier of the source Agent. Format: * `urn:agent:{publisher}:{namespace}:{name}`
+      },
+      "target": { # The target of the Binding. # Required. The target Agent Registry Resource of the Binding.
+        "identifier": "A String", # The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher}:{namespace}:{name}` * `urn:mcp:{publisher}:{namespace}:{name}` * `urn:endpoint:{publisher}:{namespace}:{name}`
+      },
+      "updateTime": "A String", # Output only. Timestamp when this binding was last updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return. Used in page_token.
+}
+
+ +
+ 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, requestId=None, updateMask=None, x__xgafv=None) +
Updates the parameters of a single Binding.
+
+Args:
+  name: string, Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a user-defined Binding.
+  "authProviderBinding": { # The AuthProvider of the Binding. # The binding for AuthProvider.
+    "authProvider": "A String", # Required. The resource name of the target AuthProvider. Format: * `projects/{project}/locations/{location}/authProviders/{auth_provider}`
+    "continueUri": "A String", # Optional. The continue URI of the AuthProvider. The URI is used to reauthenticate the user and finalize the managed OAuth flow.
+    "scopes": [ # Optional. The list of OAuth2 scopes of the AuthProvider.
+      "A String",
+    ],
+  },
+  "createTime": "A String", # Output only. Timestamp when this binding was created.
+  "description": "A String", # Optional. User-defined description of a Binding. Can have a maximum length of `2048` characters.
+  "displayName": "A String", # Optional. User-defined display name for the Binding. Can have a maximum length of `63` characters.
+  "name": "A String", # Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`.
+  "source": { # The source of the Binding. # Required. The target Agent of the Binding.
+    "identifier": "A String", # The identifier of the source Agent. Format: * `urn:agent:{publisher}:{namespace}:{name}`
+  },
+  "target": { # The target of the Binding. # Required. The target Agent Registry Resource of the Binding.
+    "identifier": "A String", # The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher}:{namespace}:{name}` * `urn:mcp:{publisher}:{namespace}:{name}` * `urn:endpoint:{publisher}:{namespace}:{name}`
+  },
+  "updateTime": "A String", # Output only. Timestamp when this binding was last updated.
+}
+
+  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 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).
+  updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Binding 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 present in the request will be overwritten.
+  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/agentregistry_v1alpha.projects.locations.html b/docs/dyn/agentregistry_v1alpha.projects.locations.html index d946577bc8..e33b61abfb 100644 --- a/docs/dyn/agentregistry_v1alpha.projects.locations.html +++ b/docs/dyn/agentregistry_v1alpha.projects.locations.html @@ -79,6 +79,11 @@

Instance Methods

Returns the agents Resource.

+

+ bindings() +

+

Returns the bindings Resource.

+

endpoints()

diff --git a/docs/dyn/agentregistry_v1alpha.projects.locations.mcpServers.html b/docs/dyn/agentregistry_v1alpha.projects.locations.mcpServers.html index 03af1328aa..c559484dce 100644 --- a/docs/dyn/agentregistry_v1alpha.projects.locations.mcpServers.html +++ b/docs/dyn/agentregistry_v1alpha.projects.locations.mcpServers.html @@ -133,7 +133,7 @@

Method Details

{ # 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 + "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. @@ -187,7 +187,7 @@

Method Details

{ # 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 + "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. @@ -263,7 +263,7 @@

Method Details

{ # 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 + "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. diff --git a/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json b/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json index 6816efdf52..5ec59493df 100644 --- a/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json @@ -306,6 +306,240 @@ } } }, +"bindings": { +"methods": { +"create": { +"description": "Creates a new Binding in a given project and location.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/bindings", +"httpMethod": "POST", +"id": "agentregistry.projects.locations.bindings.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"bindingId": { +"description": "Required. The ID to use for the binding, which will become the final component of the binding's resource name. This value should be 4-63 characters, and must conform to RFC-1034. Specifically, it must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project and location to create the Binding in. Expected format: `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and 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": "v1alpha/{+parent}/bindings", +"request": { +"$ref": "Binding" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-write", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single Binding.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/bindings/{bindingsId}", +"httpMethod": "DELETE", +"id": "agentregistry.projects.locations.bindings.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/bindings/[^/]+$", +"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": "v1alpha/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-write", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"fetchAvailable": { +"description": "Fetches available Bindings.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/bindings:fetchAvailable", +"httpMethod": "GET", +"id": "agentregistry.projects.locations.bindings.fetchAvailable", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Requested page size. Server may return fewer items than requested. Page size is 500 if unspecified and is capped at `500` even if a larger value is given.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent, in the format `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"sourceIdentifier": { +"description": "The identifier of the source Agent. Format: * `urn:agent:{publisher}:{namespace}:{name}`", +"location": "query", +"type": "string" +}, +"targetIdentifier": { +"description": "Optional. The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher}:{namespace}:{name}` * `urn:mcp:{publisher}:{namespace}:{name}` * `urn:endpoint:{publisher}:{namespace}:{name}`", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+parent}/bindings:fetchAvailable", +"response": { +"$ref": "FetchAvailableBindingsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-write", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single Binding.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/bindings/{bindingsId}", +"httpMethod": "GET", +"id": "agentregistry.projects.locations.bindings.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/bindings/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Binding" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-write", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Bindings in a given project and location.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/bindings", +"httpMethod": "GET", +"id": "agentregistry.projects.locations.bindings.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A query string used to filter the list of bindings returned. The filter expression must follow AIP-160 syntax.", +"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. Page size is 500 if unspecified and is capped at `500` even if a larger value is given.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project and location to list bindings in. Expected format: `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/bindings", +"response": { +"$ref": "ListBindingsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-write", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the parameters of a single Binding.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/bindings/{bindingsId}", +"httpMethod": "PATCH", +"id": "agentregistry.projects.locations.bindings.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/bindings/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Optional. Field mask is used to specify the fields to be overwritten in the Binding 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 present in the request will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "Binding" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/agentregistry.read-write", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "endpoints": { "methods": { "get": { @@ -819,7 +1053,7 @@ } } }, -"revision": "20260406", +"revision": "20260408", "rootUrl": "https://agentregistry.googleapis.com/", "schemas": { "Agent": { @@ -947,7 +1181,7 @@ "type": "boolean" }, "idempotentHint": { -"description": "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", +"description": "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", "readOnly": true, "type": "boolean" }, @@ -969,6 +1203,71 @@ }, "type": "object" }, +"AuthProviderBinding": { +"description": "The AuthProvider of the Binding.", +"id": "AuthProviderBinding", +"properties": { +"authProvider": { +"description": "Required. The resource name of the target AuthProvider. Format: * `projects/{project}/locations/{location}/authProviders/{auth_provider}`", +"type": "string" +}, +"continueUri": { +"description": "Optional. The continue URI of the AuthProvider. The URI is used to reauthenticate the user and finalize the managed OAuth flow.", +"type": "string" +}, +"scopes": { +"description": "Optional. The list of OAuth2 scopes of the AuthProvider.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"Binding": { +"description": "Represents a user-defined Binding.", +"id": "Binding", +"properties": { +"authProviderBinding": { +"$ref": "AuthProviderBinding", +"description": "The binding for AuthProvider." +}, +"createTime": { +"description": "Output only. Timestamp when this binding was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. User-defined description of a Binding. Can have a maximum length of `2048` characters.", +"type": "string" +}, +"displayName": { +"description": "Optional. User-defined display name for the Binding. Can have a maximum length of `63` characters.", +"type": "string" +}, +"name": { +"description": "Required. Identifier. The resource name of the Binding. Format: `projects/{project}/locations/{location}/bindings/{binding}`.", +"type": "string" +}, +"source": { +"$ref": "Source", +"description": "Required. The target Agent of the Binding." +}, +"target": { +"$ref": "Target", +"description": "Required. The target Agent Registry Resource of the Binding." +}, +"updateTime": { +"description": "Output only. Timestamp when this binding was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -1094,6 +1393,24 @@ }, "type": "object" }, +"FetchAvailableBindingsResponse": { +"description": "Message for response to fetching available Bindings.", +"id": "FetchAvailableBindingsResponse", +"properties": { +"bindings": { +"description": "The list of Bindings.", +"items": { +"$ref": "Binding" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +} +}, +"type": "object" +}, "Interface": { "description": "Represents the connection details for an Agent or MCP Server.", "id": "Interface", @@ -1139,6 +1456,24 @@ }, "type": "object" }, +"ListBindingsResponse": { +"description": "Message for response to listing Bindings", +"id": "ListBindingsResponse", +"properties": { +"bindings": { +"description": "The list of Binding resources matching the parent and filter criteria in the request. Each Binding resource follows the format: `projects/{project}/locations/{location}/bindings/{binding}`.", +"items": { +"$ref": "Binding" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results the server should return. Used in page_token.", +"type": "string" +} +}, +"type": "object" +}, "ListEndpointsResponse": { "description": "Message for response to listing Endpoints", "id": "ListEndpointsResponse", @@ -1648,6 +1983,17 @@ }, "type": "object" }, +"Source": { +"description": "The source of the Binding.", +"id": "Source", +"properties": { +"identifier": { +"description": "The identifier of the source Agent. Format: * `urn:agent:{publisher}:{namespace}:{name}`", +"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", @@ -1675,6 +2021,17 @@ }, "type": "object" }, +"Target": { +"description": "The target of the Binding.", +"id": "Target", +"properties": { +"identifier": { +"description": "The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher}:{namespace}:{name}` * `urn:mcp:{publisher}:{namespace}:{name}` * `urn:endpoint:{publisher}:{namespace}:{name}`", +"type": "string" +} +}, +"type": "object" +}, "Tool": { "description": "Represents a single tool provided by an MCP Server.", "id": "Tool", From cc5c9d38e06279b2c6868805280ad05cbe4f392f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:40:57 +0000 Subject: [PATCH 03/32] feat(aiplatform): update the api #### aiplatform:v1 The following keys were added: - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.resources.operations.methods.cancel (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.resources.operations.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.resources.operations.methods.wait (Total Keys: 14) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentTemplates.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentTemplates.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentTemplates.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentTemplates.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentTemplates.resources.operations.methods.cancel (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentTemplates.resources.operations.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentTemplates.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentTemplates.resources.operations.methods.wait (Total Keys: 14) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.snapshot (Total Keys: 12) - resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.methods.delete (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.methods.get (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.methods.list (Total Keys: 18) - resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.resources.operations.methods.cancel (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.resources.operations.methods.delete (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.resources.operations.methods.get (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.resources.operations.methods.wait (Total Keys: 14) - resources.reasoningEngines.resources.sandboxEnvironmentTemplates.methods.create (Total Keys: 12) - resources.reasoningEngines.resources.sandboxEnvironmentTemplates.methods.delete (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironmentTemplates.methods.get (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironmentTemplates.methods.list (Total Keys: 18) - resources.reasoningEngines.resources.sandboxEnvironmentTemplates.resources.operations.methods.cancel (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironmentTemplates.resources.operations.methods.delete (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironmentTemplates.resources.operations.methods.get (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironmentTemplates.resources.operations.methods.wait (Total Keys: 14) - resources.reasoningEngines.resources.sandboxEnvironments.methods.snapshot (Total Keys: 12) - schemas.GoogleCloudAiplatformV1EvaluationParserConfig (Total Keys: 6) - schemas.GoogleCloudAiplatformV1EvaluationRunInferenceConfig.properties.parallelism (Total Keys: 2) - schemas.GoogleCloudAiplatformV1GenerateMemoriesRequest.properties.allowedTopics (Total Keys: 2) - schemas.GoogleCloudAiplatformV1IntermediateExtractedMemory.properties.context (Total Keys: 2) - schemas.GoogleCloudAiplatformV1IntermediateExtractedMemory.properties.structuredData (Total Keys: 3) - schemas.GoogleCloudAiplatformV1LLMBasedMetricSpec.properties.resultParserConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1ListSandboxEnvironmentSnapshotsResponse (Total Keys: 5) - schemas.GoogleCloudAiplatformV1ListSandboxEnvironmentTemplatesResponse (Total Keys: 5) - schemas.GoogleCloudAiplatformV1MemoryBankCustomizationConfig.properties.disableNaturalLanguageMemories.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1MemoryGenerationTriggerConfig (Total Keys: 11) - schemas.GoogleCloudAiplatformV1ReasoningEngineContextSpecMemoryBankConfigGenerationConfig.properties.generationTriggerConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1RetrieveMemoriesRequest.properties.memoryTypes (Total Keys: 2) - schemas.GoogleCloudAiplatformV1SandboxEnvironmentConnectionInfo.properties.sandboxHostname (Total Keys: 2) - schemas.GoogleCloudAiplatformV1SandboxEnvironmentSnapshot (Total Keys: 22) - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplate (Total Keys: 42) #### aiplatform:v1beta1 The following keys were added: - resources.onlineEvaluators.resources.operations.methods.cancel (Total Keys: 11) - resources.onlineEvaluators.resources.operations.methods.delete (Total Keys: 11) - resources.onlineEvaluators.resources.operations.methods.get (Total Keys: 11) - resources.onlineEvaluators.resources.operations.methods.list (Total Keys: 20) - resources.onlineEvaluators.resources.operations.methods.wait (Total Keys: 14) - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.cancel (Total Keys: 11) - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.wait (Total Keys: 14) - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.ingestEvents (Total Keys: 12) - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.retrieveProfiles (Total Keys: 12) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.resources.operations.methods.cancel (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.resources.operations.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.resources.operations.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.resources.operations.methods.wait (Total Keys: 14) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentTemplates.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentTemplates.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentTemplates.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentTemplates.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentTemplates.resources.operations.methods.cancel (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentTemplates.resources.operations.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentTemplates.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentTemplates.resources.operations.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironmentTemplates.resources.operations.methods.wait (Total Keys: 14) - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.snapshot (Total Keys: 12) - resources.reasoningEngines.resources.memories.methods.ingestEvents (Total Keys: 12) - resources.reasoningEngines.resources.memories.methods.retrieveProfiles (Total Keys: 12) - resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.methods.delete (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.methods.get (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.methods.list (Total Keys: 18) - resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.resources.operations.methods.cancel (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.resources.operations.methods.delete (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.resources.operations.methods.get (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.resources.operations.methods.list (Total Keys: 20) - resources.reasoningEngines.resources.sandboxEnvironmentSnapshots.resources.operations.methods.wait (Total Keys: 14) - resources.reasoningEngines.resources.sandboxEnvironmentTemplates.methods.create (Total Keys: 12) - resources.reasoningEngines.resources.sandboxEnvironmentTemplates.methods.delete (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironmentTemplates.methods.get (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironmentTemplates.methods.list (Total Keys: 18) - resources.reasoningEngines.resources.sandboxEnvironmentTemplates.resources.operations.methods.cancel (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironmentTemplates.resources.operations.methods.delete (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironmentTemplates.resources.operations.methods.get (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironmentTemplates.resources.operations.methods.list (Total Keys: 20) - resources.reasoningEngines.resources.sandboxEnvironmentTemplates.resources.operations.methods.wait (Total Keys: 14) - resources.reasoningEngines.resources.sandboxEnvironments.methods.snapshot (Total Keys: 12) - schemas.GoogleCloudAiplatformV1beta1ActivateOnlineEvaluatorOperationMetadata (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1CreateOnlineEvaluatorOperationMetadata (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1DeleteOnlineEvaluatorOperationMetadata (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1EvaluationParserConfig (Total Keys: 6) - schemas.GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig.properties.parallelism (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1EvaluationSet.properties.agentConfigs (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1GenerateMemoriesRequest.properties.allowedTopics (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1IngestEventsRequest (Total Keys: 8) - schemas.GoogleCloudAiplatformV1beta1IngestionDirectContentsSource (Total Keys: 10) - schemas.GoogleCloudAiplatformV1beta1IntermediateExtractedMemory.properties.context (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1IntermediateExtractedMemory.properties.structuredData (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1LLMBasedMetricSpec.properties.resultParserConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ListSandboxEnvironmentSnapshotsResponse (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1ListSandboxEnvironmentTemplatesResponse (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1Memory.properties.memoryType.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1Memory.properties.structuredContent.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfig.properties.disableNaturalLanguageMemories.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfig (Total Keys: 11) - schemas.GoogleCloudAiplatformV1beta1MemoryProfile (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1MemoryStructuredContent (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1OnlineEvaluator.properties.stateDetails (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1OnlineEvaluatorStateDetails (Total Keys: 4) - schemas.GoogleCloudAiplatformV1beta1RagChunk.properties.chunkId.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1RagChunk.properties.fileId.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ReasoningEngine.properties.trafficConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfig.properties.structuredMemoryConfigs (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigGenerationConfig.properties.generationTriggerConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec.properties.agentGatewayConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpecAgentGatewayConfig (Total Keys: 10) - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfig (Total Keys: 14) - schemas.GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest.properties.memoryTypes (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1RetrieveProfilesRequest (Total Keys: 4) - schemas.GoogleCloudAiplatformV1beta1RetrieveProfilesResponse (Total Keys: 4) - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentConnectionInfo.properties.sandboxHostname (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentSnapshot (Total Keys: 22) - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplate (Total Keys: 42) - schemas.GoogleCloudAiplatformV1beta1StructuredMemoryConfig (Total Keys: 11) - schemas.GoogleCloudAiplatformV1beta1SuspendOnlineEvaluatorOperationMetadata (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1UpdateOnlineEvaluatorOperationMetadata (Total Keys: 3) --- ..._v1.projects.locations.evaluationRuns.html | 24 + .../dyn/aiplatform_v1.projects.locations.html | 15 + ...1.projects.locations.reasoningEngines.html | 183 +- ...s.locations.reasoningEngines.memories.html | 269 +- ...s.reasoningEngines.memories.revisions.html | 42 +- ...ons.reasoningEngines.runtimeRevisions.html | 156 + ...ngEngines.sandboxEnvironmentSnapshots.html | 218 + ...andboxEnvironmentSnapshots.operations.html | 205 + ...ngEngines.sandboxEnvironmentTemplates.html | 330 + ...andboxEnvironmentTemplates.operations.html | 205 + ....reasoningEngines.sandboxEnvironments.html | 58 + ...form_v1.projects.locations.tuningJobs.html | 25 + docs/dyn/aiplatform_v1.reasoningEngines.html | 183 +- ..._v1.reasoningEngines.runtimeRevisions.html | 156 + ...ngEngines.sandboxEnvironmentSnapshots.html | 218 + ...andboxEnvironmentSnapshots.operations.html | 205 + ...ngEngines.sandboxEnvironmentTemplates.html | 330 + ...andboxEnvironmentTemplates.operations.html | 205 + ....reasoningEngines.sandboxEnvironments.html | 58 + docs/dyn/aiplatform_v1.v1.html | 15 + docs/dyn/aiplatform_v1beta1.endpoints.html | 4 + docs/dyn/aiplatform_v1beta1.html | 5 + .../aiplatform_v1beta1.onlineEvaluators.html | 91 + ...m_v1beta1.onlineEvaluators.operations.html | 272 + ..._v1beta1.projects.locations.endpoints.html | 4 + ....projects.locations.evaluationMetrics.html | 28 +- ...ta1.projects.locations.evaluationRuns.html | 24 + ...ta1.projects.locations.evaluationSets.html | 1404 +++ ...aiplatform_v1beta1.projects.locations.html | 23 + ...1.projects.locations.onlineEvaluators.html | 77 +- ...locations.onlineEvaluators.operations.html | 272 + ....projects.locations.publishers.models.html | 4 + ...s.locations.reasoningEngines.a2aTasks.html | 2 +- ...1.projects.locations.reasoningEngines.html | 466 +- ...s.locations.reasoningEngines.memories.html | 482 +- ...s.reasoningEngines.memories.revisions.html | 42 +- ...reasoningEngines.runtimeRevisions.a2a.html | 149 + ...gEngines.runtimeRevisions.a2a.message.html | 140 + ...ingEngines.runtimeRevisions.a2a.tasks.html | 168 + ...ons.a2a.tasks.pushNotificationConfigs.html | 110 + ...soningEngines.runtimeRevisions.a2a.v1.html | 144 + ...gines.runtimeRevisions.a2a.v1.message.html | 140 + ...Engines.runtimeRevisions.a2a.v1.tasks.html | 168 + ....a2a.v1.tasks.pushNotificationConfigs.html | 110 + ...ons.reasoningEngines.runtimeRevisions.html | 396 + ...ngEngines.sandboxEnvironmentSnapshots.html | 218 + ...andboxEnvironmentSnapshots.operations.html | 272 + ...ngEngines.sandboxEnvironmentTemplates.html | 330 + ...andboxEnvironmentTemplates.operations.html | 272 + ....reasoningEngines.sandboxEnvironments.html | 58 + ...ions.reasoningEngines.sessions.events.html | 2 + ...s.locations.reasoningEngines.sessions.html | 2 + ...v1beta1.projects.locations.tuningJobs.html | 25 + .../aiplatform_v1beta1.publishers.models.html | 4 + .../aiplatform_v1beta1.reasoningEngines.html | 466 +- ...orm_v1beta1.reasoningEngines.memories.html | 482 +- ...1.reasoningEngines.memories.revisions.html | 42 +- ...reasoningEngines.runtimeRevisions.a2a.html | 149 + ...gEngines.runtimeRevisions.a2a.message.html | 140 + ...ingEngines.runtimeRevisions.a2a.tasks.html | 168 + ...ons.a2a.tasks.pushNotificationConfigs.html | 110 + ...soningEngines.runtimeRevisions.a2a.v1.html | 144 + ...gines.runtimeRevisions.a2a.v1.message.html | 140 + ...Engines.runtimeRevisions.a2a.v1.tasks.html | 168 + ....a2a.v1.tasks.pushNotificationConfigs.html | 110 + ...ta1.reasoningEngines.runtimeRevisions.html | 75 + ...ngEngines.sandboxEnvironmentSnapshots.html | 218 + ...andboxEnvironmentSnapshots.operations.html | 272 + ...ngEngines.sandboxEnvironmentTemplates.html | 330 + ...andboxEnvironmentTemplates.operations.html | 272 + ....reasoningEngines.sandboxEnvironments.html | 58 + ...eta1.reasoningEngines.sessions.events.html | 2 + ...orm_v1beta1.reasoningEngines.sessions.html | 2 + docs/dyn/aiplatform_v1beta1.v1beta1.html | 15 + .../documents/aiplatform.v1.json | 5937 ++++++---- .../documents/aiplatform.v1beta1.json | 9994 ++++++++++++----- 76 files changed, 22517 insertions(+), 5785 deletions(-) create mode 100644 docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.runtimeRevisions.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.html create mode 100644 docs/dyn/aiplatform_v1.reasoningEngines.runtimeRevisions.html create mode 100644 docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentSnapshots.html create mode 100644 docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentSnapshots.operations.html create mode 100644 docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentTemplates.html create mode 100644 docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentTemplates.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.onlineEvaluators.html create mode 100644 docs/dyn/aiplatform_v1beta1.onlineEvaluators.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.message.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.pushNotificationConfigs.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.message.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.pushNotificationConfigs.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.message.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.tasks.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.tasks.pushNotificationConfigs.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.v1.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.v1.message.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.v1.tasks.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.v1.tasks.pushNotificationConfigs.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentSnapshots.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentSnapshots.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.operations.html diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html index 4e175834e4..c553515caf 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html @@ -699,6 +699,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -1541,6 +1546,7 @@

Method Details

"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. }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. }, }, "labels": { # Optional. Labels for the evaluation run. @@ -2124,6 +2130,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -2966,6 +2977,7 @@

Method Details

"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. }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. }, }, "labels": { # Optional. Labels for the evaluation run. @@ -3591,6 +3603,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -4433,6 +4450,7 @@

Method Details

"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. }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. }, }, "labels": { # Optional. Labels for the evaluation run. @@ -5029,6 +5047,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -5871,6 +5894,7 @@

Method Details

"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. }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. }, }, "labels": { # Optional. Labels for the evaluation run. diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index 0732f25e4e..3bc294b87d 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -1741,6 +1741,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -3942,6 +3947,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -4261,6 +4271,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html index 5124091dae..428ffb4828 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html @@ -84,6 +84,21 @@

Instance Methods

Returns the operations Resource.

+

+ runtimeRevisions() +

+

Returns the runtimeRevisions Resource.

+ +

+ sandboxEnvironmentSnapshots() +

+

Returns the sandboxEnvironmentSnapshots Resource.

+ +

+ sandboxEnvironmentTemplates() +

+

Returns the sandboxEnvironmentTemplates Resource.

+

sandboxEnvironments()

@@ -152,17 +167,18 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Represents configuration for organizing memories for a particular scope. + { # Represents configuration for organizing natural language memories for a particular scope. "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. - "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + "revisionsPerCandidateCount": 42, # Optional. Represents the maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. }, - "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") - "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. + "disableNaturalLanguageMemories": True or False, # Optional. Indicates whether natural language memory generation should be disabled for all requests. By default, natural language memory generation is enabled. Set this to `true` when you only want to generate structured memories. + "enableThirdPersonMemories": True or False, # Optional. Indicates whether the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") + "generateMemoriesExamples": [ # Optional. Provides examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. "conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. - "events": [ # Optional. The input conversation events for the example. + "events": [ # Optional. Represents the input conversation events for the example. { # A single conversation event. - "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. + "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. Represents the content of the event. "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. @@ -239,38 +255,45 @@

Method Details

}, ], }, - "generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. + "generatedMemories": [ # Optional. Represents the memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. - "fact": "A String", # Required. The fact to generate a memory from. - "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + "fact": "A String", # Required. Represents the fact to generate a memory from. + "topics": [ # Optional. Represents the list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], }, ], }, ], - "memoryTopics": [ # Optional. Topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. + "memoryTopics": [ # Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. { # A topic of information that should be extracted from conversations and stored as memories. "customMemoryTopic": { # A custom memory topic defined by the developer. # A custom memory topic defined by the developer. - "description": "A String", # Required. Description of the memory topic. This should explain what information should be extracted for this topic. - "label": "A String", # Required. The label of the topic. + "description": "A String", # Required. Represents the description of the memory topic. This should explain what information should be extracted for this topic. + "label": "A String", # Required. Represents the label of the topic. }, "managedMemoryTopic": { # A managed memory topic defined by the system. # A managed memory topic defined by Memory Bank. - "managedTopicEnum": "A String", # Required. The managed topic. + "managedTopicEnum": "A String", # Required. Represents the managed topic. }, }, ], - "scopeKeys": [ # Optional. The scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. "A String", ], }, ], "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. - "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. + "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Specifies the default trigger configuration for generating memories using `IngestEvents`. + "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately. + "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. + "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. + "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + }, + }, + "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, "similaritySearchConfig": { # Configuration for how to perform similarity search on memories. # Optional. Configuration for how to perform similarity search on memories. If not set, the Memory Bank will use the default embedding model `text-embedding-005`. "embeddingModel": "A String", # Required. The model used to generate embeddings to lookup similar memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -522,17 +545,18 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Represents configuration for organizing memories for a particular scope. + { # Represents configuration for organizing natural language memories for a particular scope. "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. - "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + "revisionsPerCandidateCount": 42, # Optional. Represents the maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. }, - "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") - "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. + "disableNaturalLanguageMemories": True or False, # Optional. Indicates whether natural language memory generation should be disabled for all requests. By default, natural language memory generation is enabled. Set this to `true` when you only want to generate structured memories. + "enableThirdPersonMemories": True or False, # Optional. Indicates whether the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") + "generateMemoriesExamples": [ # Optional. Provides examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. "conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. - "events": [ # Optional. The input conversation events for the example. + "events": [ # Optional. Represents the input conversation events for the example. { # A single conversation event. - "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. + "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. Represents the content of the event. "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. @@ -609,38 +633,45 @@

Method Details

}, ], }, - "generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. + "generatedMemories": [ # Optional. Represents the memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. - "fact": "A String", # Required. The fact to generate a memory from. - "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + "fact": "A String", # Required. Represents the fact to generate a memory from. + "topics": [ # Optional. Represents the list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], }, ], }, ], - "memoryTopics": [ # Optional. Topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. + "memoryTopics": [ # Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. { # A topic of information that should be extracted from conversations and stored as memories. "customMemoryTopic": { # A custom memory topic defined by the developer. # A custom memory topic defined by the developer. - "description": "A String", # Required. Description of the memory topic. This should explain what information should be extracted for this topic. - "label": "A String", # Required. The label of the topic. + "description": "A String", # Required. Represents the description of the memory topic. This should explain what information should be extracted for this topic. + "label": "A String", # Required. Represents the label of the topic. }, "managedMemoryTopic": { # A managed memory topic defined by the system. # A managed memory topic defined by Memory Bank. - "managedTopicEnum": "A String", # Required. The managed topic. + "managedTopicEnum": "A String", # Required. Represents the managed topic. }, }, ], - "scopeKeys": [ # Optional. The scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. "A String", ], }, ], "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. - "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. + "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Specifies the default trigger configuration for generating memories using `IngestEvents`. + "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately. + "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. + "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. + "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + }, + }, + "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, "similaritySearchConfig": { # Configuration for how to perform similarity search on memories. # Optional. Configuration for how to perform similarity search on memories. If not set, the Memory Bank will use the default embedding model `text-embedding-005`. "embeddingModel": "A String", # Required. The model used to generate embeddings to lookup similar memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -823,17 +854,18 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Represents configuration for organizing memories for a particular scope. + { # Represents configuration for organizing natural language memories for a particular scope. "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. - "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + "revisionsPerCandidateCount": 42, # Optional. Represents the maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. }, - "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") - "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. + "disableNaturalLanguageMemories": True or False, # Optional. Indicates whether natural language memory generation should be disabled for all requests. By default, natural language memory generation is enabled. Set this to `true` when you only want to generate structured memories. + "enableThirdPersonMemories": True or False, # Optional. Indicates whether the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") + "generateMemoriesExamples": [ # Optional. Provides examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. "conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. - "events": [ # Optional. The input conversation events for the example. + "events": [ # Optional. Represents the input conversation events for the example. { # A single conversation event. - "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. + "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. Represents the content of the event. "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. @@ -910,38 +942,45 @@

Method Details

}, ], }, - "generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. + "generatedMemories": [ # Optional. Represents the memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. - "fact": "A String", # Required. The fact to generate a memory from. - "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + "fact": "A String", # Required. Represents the fact to generate a memory from. + "topics": [ # Optional. Represents the list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], }, ], }, ], - "memoryTopics": [ # Optional. Topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. + "memoryTopics": [ # Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. { # A topic of information that should be extracted from conversations and stored as memories. "customMemoryTopic": { # A custom memory topic defined by the developer. # A custom memory topic defined by the developer. - "description": "A String", # Required. Description of the memory topic. This should explain what information should be extracted for this topic. - "label": "A String", # Required. The label of the topic. + "description": "A String", # Required. Represents the description of the memory topic. This should explain what information should be extracted for this topic. + "label": "A String", # Required. Represents the label of the topic. }, "managedMemoryTopic": { # A managed memory topic defined by the system. # A managed memory topic defined by Memory Bank. - "managedTopicEnum": "A String", # Required. The managed topic. + "managedTopicEnum": "A String", # Required. Represents the managed topic. }, }, ], - "scopeKeys": [ # Optional. The scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. "A String", ], }, ], "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. - "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. + "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Specifies the default trigger configuration for generating memories using `IngestEvents`. + "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately. + "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. + "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. + "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + }, + }, + "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, "similaritySearchConfig": { # Configuration for how to perform similarity search on memories. # Optional. Configuration for how to perform similarity search on memories. If not set, the Memory Bank will use the default embedding model `text-embedding-005`. "embeddingModel": "A String", # Required. The model used to generate embeddings to lookup similar memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -1094,17 +1133,18 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Represents configuration for organizing memories for a particular scope. + { # Represents configuration for organizing natural language memories for a particular scope. "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. - "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + "revisionsPerCandidateCount": 42, # Optional. Represents the maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. }, - "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") - "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. + "disableNaturalLanguageMemories": True or False, # Optional. Indicates whether natural language memory generation should be disabled for all requests. By default, natural language memory generation is enabled. Set this to `true` when you only want to generate structured memories. + "enableThirdPersonMemories": True or False, # Optional. Indicates whether the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") + "generateMemoriesExamples": [ # Optional. Provides examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. "conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. - "events": [ # Optional. The input conversation events for the example. + "events": [ # Optional. Represents the input conversation events for the example. { # A single conversation event. - "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. + "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. Represents the content of the event. "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. @@ -1181,38 +1221,45 @@

Method Details

}, ], }, - "generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. + "generatedMemories": [ # Optional. Represents the memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. - "fact": "A String", # Required. The fact to generate a memory from. - "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + "fact": "A String", # Required. Represents the fact to generate a memory from. + "topics": [ # Optional. Represents the list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], }, ], }, ], - "memoryTopics": [ # Optional. Topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. + "memoryTopics": [ # Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. { # A topic of information that should be extracted from conversations and stored as memories. "customMemoryTopic": { # A custom memory topic defined by the developer. # A custom memory topic defined by the developer. - "description": "A String", # Required. Description of the memory topic. This should explain what information should be extracted for this topic. - "label": "A String", # Required. The label of the topic. + "description": "A String", # Required. Represents the description of the memory topic. This should explain what information should be extracted for this topic. + "label": "A String", # Required. Represents the label of the topic. }, "managedMemoryTopic": { # A managed memory topic defined by the system. # A managed memory topic defined by Memory Bank. - "managedTopicEnum": "A String", # Required. The managed topic. + "managedTopicEnum": "A String", # Required. Represents the managed topic. }, }, ], - "scopeKeys": [ # Optional. The scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. "A String", ], }, ], "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. - "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. + "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Specifies the default trigger configuration for generating memories using `IngestEvents`. + "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately. + "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. + "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. + "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + }, + }, + "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, "similaritySearchConfig": { # Configuration for how to perform similarity search on memories. # Optional. Configuration for how to perform similarity search on memories. If not set, the Memory Bank will use the default embedding model `text-embedding-005`. "embeddingModel": "A String", # Required. The model used to generate embeddings to lookup similar memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html index f3fd5c811e..d4c3cb5f3f 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html @@ -133,37 +133,37 @@

Method Details

The object takes the form of: { # A memory. - "createTime": "A String", # Output only. Timestamp when this Memory was created. - "description": "A String", # Optional. Description of the Memory. - "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", # 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. + "createTime": "A String", # Output only. Represents the timestamp when this Memory was created. + "description": "A String", # Optional. Represents the description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request. + "displayName": "A String", # Optional. Represents the display name of the Memory. + "expireTime": "A String", # Optional. Represents the 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", # Optional. Represents semantic knowledge extracted from the source content. + "metadata": { # Optional. Represents 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. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, - "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` - "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. - "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request. "a_key": "A String", }, - "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. - "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. + "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL. + "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, - "topics": [ # Optional. The Topics of the Memory. + "topics": [ # Optional. Represents the Topics of the Memory. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], - "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. - "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. + "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL. + "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated. } memoryId: string, Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number. @@ -241,6 +241,12 @@

Method Details

The object takes the form of: { # Request message for MemoryBankService.GenerateMemories. Maximum size is 8 MB. + "allowedTopics": [ # Optional. Restricts memory generation to a subset of memory topics. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. + }, + ], "directContentsSource": { # Defines a direct source of content from which to generate the memories. # Defines a direct source of content as the source content from which to generate memories. "events": [ # Required. The source content (i.e. chat history) to generate memories from. { # A single piece of conversation from which to generate memories. @@ -327,8 +333,8 @@

Method Details

"fact": "A String", # Required. The fact to consolidate with existing memories. "topics": [ # Optional. The topics that the consolidated memories should be associated with. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], }, @@ -338,10 +344,10 @@

Method Details

"disableMemoryRevisions": True or False, # Optional. If true, no revisions will be created for this request. "metadata": { # Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank. "a_key": { # Memory metadata. - "boolValue": True or False, # Boolean value. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, "metadataMergeStrategy": "A String", # Optional. The strategy to use when applying metadata to existing memories. @@ -404,37 +410,37 @@

Method Details

An object of the form: { # A memory. - "createTime": "A String", # Output only. Timestamp when this Memory was created. - "description": "A String", # Optional. Description of the Memory. - "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", # 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. + "createTime": "A String", # Output only. Represents the timestamp when this Memory was created. + "description": "A String", # Optional. Represents the description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request. + "displayName": "A String", # Optional. Represents the display name of the Memory. + "expireTime": "A String", # Optional. Represents the 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", # Optional. Represents semantic knowledge extracted from the source content. + "metadata": { # Optional. Represents 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. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, - "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` - "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. - "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request. "a_key": "A String", }, - "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. - "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. + "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL. + "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, - "topics": [ # Optional. The Topics of the Memory. + "topics": [ # Optional. Represents the Topics of the Memory. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], - "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. - "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. + "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL. + "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated. } @@ -459,37 +465,37 @@

Method Details

{ # Response message for MemoryBankService.ListMemories. "memories": [ # List of Memories in the requested page. { # A memory. - "createTime": "A String", # Output only. Timestamp when this Memory was created. - "description": "A String", # Optional. Description of the Memory. - "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", # 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. + "createTime": "A String", # Output only. Represents the timestamp when this Memory was created. + "description": "A String", # Optional. Represents the description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request. + "displayName": "A String", # Optional. Represents the display name of the Memory. + "expireTime": "A String", # Optional. Represents the 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", # Optional. Represents semantic knowledge extracted from the source content. + "metadata": { # Optional. Represents 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. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, - "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` - "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. - "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request. "a_key": "A String", }, - "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. - "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. + "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL. + "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, - "topics": [ # Optional. The Topics of the Memory. + "topics": [ # Optional. Represents the Topics of the Memory. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], - "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. - "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. + "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL. + "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated. }, ], "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListMemoriesRequest.page_token to obtain that page. @@ -515,42 +521,42 @@

Method Details

Update a Memory.
 
 Args:
-  name: string, Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  name: string, Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
   body: object, The request body.
     The object takes the form of:
 
 { # A memory.
-  "createTime": "A String", # Output only. Timestamp when this Memory was created.
-  "description": "A String", # Optional. Description of the Memory.
-  "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", # 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.
+  "createTime": "A String", # Output only. Represents the timestamp when this Memory was created.
+  "description": "A String", # Optional. Represents the description of the Memory.
+  "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request.
+  "displayName": "A String", # Optional. Represents the display name of the Memory.
+  "expireTime": "A String", # Optional. Represents the 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", # Optional. Represents semantic knowledge extracted from the source content.
+  "metadata": { # Optional. Represents 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.
-      "doubleValue": 3.14, # Double value.
-      "stringValue": "A String", # String value.
-      "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+      "boolValue": True or False, # Represents a boolean value.
+      "doubleValue": 3.14, # Represents a double value.
+      "stringValue": "A String", # Represents a string value.
+      "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
     },
   },
-  "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
-  "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
-  "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request.
+  "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
+  "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+  "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
     "a_key": "A String",
   },
-  "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL.
-  "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
+  "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
+  "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
     "a_key": "A String",
   },
-  "topics": [ # Optional. The Topics of the Memory.
+  "topics": [ # Optional. Represents the Topics of the Memory.
     { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
-      "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label.
-      "managedMemoryTopic": "A String", # Optional. The managed memory topic.
+      "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+      "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
     },
   ],
-  "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.
-  "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated.
+  "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated.
 }
 
   updateMask: string, Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`
@@ -596,16 +602,16 @@ 

Method Details

"filter": "A String", # Required. The standard list filter to determine which memories to purge. More detail in [AIP-160](https://google.aip.dev/160). "filterGroups": [ # Optional. Metadata filters that will be applied to the memories to be purged. Filters are defined using disjunctive normal form (OR of ANDs). For example: `filter_groups: [{filters: [{key: "author", value: {string_value: "agent 123"}, op: EQUAL}]}, {filters: [{key: "label", value: {string_value: "travel"}, op: EQUAL}, {key: "author", value: {string_value: "agent 321"}, op: EQUAL}]}]` would be equivalent to the logical expression: `(metadata.author = "agent 123" OR (metadata.label = "travel" AND metadata.author = "agent 321"))`. { # A conjunction of filters that will be combined using AND logic. - "filters": [ # Filters that will combined using AND logic. + "filters": [ # Represents filters that will be combined using AND logic. { # Filter to apply when retrieving memories. - "key": "A String", # Key of the filter. For example, "author" would apply to `metadata` entries with the key "author". - "negate": True or False, # If true, the filter will be negated. - "op": "A String", # Operator to apply to the filter. If not set, then EQUAL will be used. - "value": { # Memory metadata. # Value to compare to. - "boolValue": True or False, # Boolean value. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "key": "A String", # Represents the key of the filter. For example, "author" would apply to `metadata` entries with the key "author". + "negate": True or False, # Indicates whether the filter will be negated. + "op": "A String", # Represents the operator to apply to the filter. If not set, then EQUAL will be used. + "value": { # Memory metadata. # Represents the value to compare to. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, ], @@ -656,21 +662,24 @@

Method Details

"filter": "A String", # Optional. The standard list filter that will be applied to the retrieved memories. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `fact` * `create_time` * `update_time` * `topics` (i.e. `topics.custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES`) "filterGroups": [ # Optional. Metadata filters that will be applied to the retrieved memories' `metadata` using OR logic. Filters are defined using disjunctive normal form (OR of ANDs). For example: `filter_groups: [{filters: [{key: "author", value: {string_value: "agent 123"}, op: EQUAL}]}, {filters: [{key: "label", value: {string_value: "travel"}, op: EQUAL}, {key: "author", value: {string_value: "agent 321"}, op: EQUAL}]}]` would be equivalent to the logical expression: `(metadata.author = "agent 123" OR (metadata.label = "travel" AND metadata.author = "agent 321"))`. { # A conjunction of filters that will be combined using AND logic. - "filters": [ # Filters that will combined using AND logic. + "filters": [ # Represents filters that will be combined using AND logic. { # Filter to apply when retrieving memories. - "key": "A String", # Key of the filter. For example, "author" would apply to `metadata` entries with the key "author". - "negate": True or False, # If true, the filter will be negated. - "op": "A String", # Operator to apply to the filter. If not set, then EQUAL will be used. - "value": { # Memory metadata. # Value to compare to. - "boolValue": True or False, # Boolean value. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "key": "A String", # Represents the key of the filter. For example, "author" would apply to `metadata` entries with the key "author". + "negate": True or False, # Indicates whether the filter will be negated. + "op": "A String", # Represents the operator to apply to the filter. If not set, then EQUAL will be used. + "value": { # Memory metadata. # Represents the value to compare to. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, ], }, ], + "memoryTypes": [ # Optional. Specifies the types of memories to retrieve. If this field is empty or not provided, the request will default to retrieving only memories of type `NATURAL_LANGUAGE_COLLECTION`. If populated, the request will retrieve memories matching any of the specified `MemoryType` values. + "A String", + ], "scope": { # Required. The scope of the memories to retrieve. A memory must have exactly the same scope (`Memory.scope`) as the scope provided here to be retrieved (same keys and values). Order does not matter, but it is case-sensitive. "a_key": "A String", }, @@ -698,37 +707,37 @@

Method Details

{ # A retrieved memory. "distance": 3.14, # The distance between the query and the retrieved Memory. Smaller values indicate more similar memories. This is only set if similarity search was used for retrieval. "memory": { # A memory. # The retrieved Memory. - "createTime": "A String", # Output only. Timestamp when this Memory was created. - "description": "A String", # Optional. Description of the Memory. - "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", # 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. + "createTime": "A String", # Output only. Represents the timestamp when this Memory was created. + "description": "A String", # Optional. Represents the description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request. + "displayName": "A String", # Optional. Represents the display name of the Memory. + "expireTime": "A String", # Optional. Represents the 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", # Optional. Represents semantic knowledge extracted from the source content. + "metadata": { # Optional. Represents 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. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, - "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` - "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. - "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request. "a_key": "A String", }, - "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. - "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. + "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL. + "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, - "topics": [ # Optional. The Topics of the Memory. + "topics": [ # Optional. Represents the Topics of the Memory. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], - "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. - "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. + "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL. + "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated. }, }, ], diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.revisions.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.revisions.html index 2be3271b60..7e05278789 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.revisions.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.revisions.html @@ -107,18 +107,25 @@

Method Details

An object of the form: { # A revision of a Memory. - "createTime": "A String", # Output only. Timestamp when this Memory Revision was created. - "expireTime": "A String", # Output only. Timestamp of when this resource is considered expired. - "extractedMemories": [ # Output only. The extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation. + "createTime": "A String", # Output only. Represents the timestamp when this Memory Revision was created. + "expireTime": "A String", # Output only. Represents the timestamp of when this resource is considered expired. + "extractedMemories": [ # Output only. Represents the extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation. { # An extracted memory that is the intermediate result before consolidation. - "fact": "A String", # Output only. The fact of the extracted memory. + "context": "A String", # Output only. Represents the explanation of why the information was extracted from the source content. + "fact": "A String", # Output only. Represents the fact of the extracted memory. + "structuredData": { # Output only. Represents the structured value of the extracted memory. + "a_key": "", # Properties of the object. + }, }, ], - "fact": "A String", # Output only. The fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation. - "labels": { # Output only. The labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`. + "fact": "A String", # Output only. Represents the fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation. + "labels": { # Output only. Represents the labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`. "a_key": "A String", }, - "name": "A String", # Identifier. The resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}` + "name": "A String", # Identifier. Represents the resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}` + "structuredData": { # Output only. Represents the structured value of the memory at the time of revision creation. + "a_key": "", # Properties of the object. + }, }
@@ -142,18 +149,25 @@

Method Details

{ # Response message for MemoryBankService.ListMemoryRevisions. "memoryRevisions": [ # The list of Memory Revisions in the request page. { # A revision of a Memory. - "createTime": "A String", # Output only. Timestamp when this Memory Revision was created. - "expireTime": "A String", # Output only. Timestamp of when this resource is considered expired. - "extractedMemories": [ # Output only. The extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation. + "createTime": "A String", # Output only. Represents the timestamp when this Memory Revision was created. + "expireTime": "A String", # Output only. Represents the timestamp of when this resource is considered expired. + "extractedMemories": [ # Output only. Represents the extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation. { # An extracted memory that is the intermediate result before consolidation. - "fact": "A String", # Output only. The fact of the extracted memory. + "context": "A String", # Output only. Represents the explanation of why the information was extracted from the source content. + "fact": "A String", # Output only. Represents the fact of the extracted memory. + "structuredData": { # Output only. Represents the structured value of the extracted memory. + "a_key": "", # Properties of the object. + }, }, ], - "fact": "A String", # Output only. The fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation. - "labels": { # Output only. The labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`. + "fact": "A String", # Output only. Represents the fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation. + "labels": { # Output only. Represents the labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`. "a_key": "A String", }, - "name": "A String", # Identifier. The resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}` + "name": "A String", # Identifier. Represents the resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}` + "structuredData": { # Output only. Represents the structured value of the memory at the time of revision creation. + "a_key": "", # Properties of the object. + }, }, ], "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. diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.runtimeRevisions.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.runtimeRevisions.html new file mode 100644 index 0000000000..c341c657bd --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.runtimeRevisions.html @@ -0,0 +1,156 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . runtimeRevisions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Queries using a reasoning engine.

+

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

+

Streams queries using a reasoning engine.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ query(name, body=None, x__xgafv=None) +
Queries using a reasoning engine.
+
+Args:
+  name: string, Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ReasoningEngineExecutionService.Query.
+  "classMethod": "A String", # Optional. Class method to be used for the query. It is optional and defaults to "query" if unspecified.
+  "input": { # Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+  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 ReasoningEngineExecutionService.Query
+  "output": "", # Response provided by users in JSON object format.
+}
+
+ +
+ streamQuery(name, body=None, x__xgafv=None) +
Streams queries using a reasoning engine.
+
+Args:
+  name: string, Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ReasoningEngineExecutionService.StreamQuery.
+  "classMethod": "A String", # Optional. Class method to be used for the stream query. It is optional and defaults to "stream_query" if unspecified.
+  "input": { # Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.html new file mode 100644 index 0000000000..376f67abcd --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.html @@ -0,0 +1,218 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . sandboxEnvironmentSnapshots

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes the specific SandboxEnvironmentSnapshot.

+

+ get(name, x__xgafv=None)

+

Gets details of the specific SandboxEnvironmentSnapshot.

+

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

+

Lists SandboxEnvironmentSnapshots in a given reasoning engine.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes the specific SandboxEnvironmentSnapshot.
+
+Args:
+  name: string, Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}` (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 the specific SandboxEnvironmentSnapshot.
+
+Args:
+  name: string, Required. The resource name of the sandbox environment snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # SandboxEnvironmentSnapshot is a snapshot of the SandboxEnvironment.
+  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentSnapshot was created.
+  "displayName": "A String", # Required. The display name of the SandboxEnvironmentSnapshot.
+  "expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironmentSnapshot is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+  "name": "A String", # Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
+  "owner": "A String", # Optional. Owner information for this sandbox snapshot. Different owners will have isolations on snapshot storage and identity. If not set, snapshot will be created as the default owner.
+  "parentSnapshot": "A String", # Output only. The resource name of the parent SandboxEnvironmentSnapshot. Empty if this is a root Snapshot (the first snapshot from a newly created sandbox). Can be used to reconstruct the whole ancestry tree of snapshots.
+  "postSnapshotAction": "A String", # Optional. Input only. Action to take on the source SandboxEnvironment after the snapshot is taken. This field is only used in CreateSandboxEnvironmentSnapshotRequest and it is not stored in the resource.
+  "sizeBytes": "A String", # Optional. Output only. Size of the snapshot data in bytes.
+  "sourceSandboxEnvironment": "A String", # Required. The resource name of the source SandboxEnvironment this snapshot was taken from.
+  "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently updated.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists SandboxEnvironmentSnapshots in a given reasoning engine.
+
+Args:
+  parent: string, Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
+  pageSize: integer, Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100.
+  pageToken: string, Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page.
+  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 SandboxEnvironmentService.ListSandboxEnvironmentSnapshots.
+  "nextPageToken": "A String", # A token, which can be sent as ListSandboxEnvironmentSnapshotsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.
+  "sandboxEnvironmentSnapshots": [ # The SandboxEnvironmentSnapshots matching the request.
+    { # SandboxEnvironmentSnapshot is a snapshot of the SandboxEnvironment.
+      "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentSnapshot was created.
+      "displayName": "A String", # Required. The display name of the SandboxEnvironmentSnapshot.
+      "expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironmentSnapshot is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+      "name": "A String", # Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
+      "owner": "A String", # Optional. Owner information for this sandbox snapshot. Different owners will have isolations on snapshot storage and identity. If not set, snapshot will be created as the default owner.
+      "parentSnapshot": "A String", # Output only. The resource name of the parent SandboxEnvironmentSnapshot. Empty if this is a root Snapshot (the first snapshot from a newly created sandbox). Can be used to reconstruct the whole ancestry tree of snapshots.
+      "postSnapshotAction": "A String", # Optional. Input only. Action to take on the source SandboxEnvironment after the snapshot is taken. This field is only used in CreateSandboxEnvironmentSnapshotRequest and it is not stored in the resource.
+      "sizeBytes": "A String", # Optional. Output only. Size of the snapshot data in bytes.
+      "sourceSandboxEnvironment": "A String", # Required. The resource name of the source SandboxEnvironment this snapshot was taken from.
+      "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.
+      "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently 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.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.html new file mode 100644 index 0000000000..98ebd2096b --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.html @@ -0,0 +1,205 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . sandboxEnvironmentSnapshots . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

+

+ 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.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ 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.
+  },
+}
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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_v1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html new file mode 100644 index 0000000000..0d51f330fb --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html @@ -0,0 +1,330 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . sandboxEnvironmentTemplates

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates a SandboxEnvironmentTemplate in a given reasoning engine.

+

+ delete(name, x__xgafv=None)

+

Deletes the specific SandboxEnvironmentTemplate.

+

+ get(name, x__xgafv=None)

+

Gets details of the specific SandboxEnvironmentTemplate.

+

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

+

Lists SandboxEnvironmentTemplates in a given reasoning engine.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a SandboxEnvironmentTemplate in a given reasoning engine.
+
+Args:
+  parent: string, Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The specification of a SandboxEnvironmentTemplate. A SandboxEnvironmentTemplate defines a template for creating SandboxEnvironments.
+  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was created.
+  "customContainerEnvironment": { # The customized sandbox runtime environment for BYOC. # The sandbox environment for custom container workloads.
+    "customContainerSpec": { # Specification for deploying from a custom container image. # The specification of the custom container environment.
+      "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.
+    },
+    "ports": [ # Ports to expose from the container.
+      { # Represents a network port in a container.
+        "port": 42, # Optional. Port number to expose. This must be a valid port number, between 1 and 65535.
+        "protocol": "A String", # Optional. Protocol for port. Defaults to TCP if not specified.
+      },
+    ],
+    "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Resource requests and limits for the container.
+      "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi").
+        "a_key": "A String",
+      },
+      "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi").
+        "a_key": "A String",
+      },
+    },
+  },
+  "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads.
+    "defaultContainerCategory": "A String", # Required. The category of the default container image.
+  },
+  "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+  "name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
+  "state": "A String", # Output only. The state of the sandbox environment template.
+  "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
+  "warmPoolConfig": { # Configuration for a warm pool of sandbox instances. # Optional. The configuration for the warm pool of this template.
+    "targetInstanceCount": 42, # Optional. The target number of pre-warmed instances to maintain.
+  },
+}
+
+  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 the specific SandboxEnvironmentTemplate.
+
+Args:
+  name: string, Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` (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 the specific SandboxEnvironmentTemplate.
+
+Args:
+  name: string, Required. The resource name of the sandbox environment template. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The specification of a SandboxEnvironmentTemplate. A SandboxEnvironmentTemplate defines a template for creating SandboxEnvironments.
+  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was created.
+  "customContainerEnvironment": { # The customized sandbox runtime environment for BYOC. # The sandbox environment for custom container workloads.
+    "customContainerSpec": { # Specification for deploying from a custom container image. # The specification of the custom container environment.
+      "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.
+    },
+    "ports": [ # Ports to expose from the container.
+      { # Represents a network port in a container.
+        "port": 42, # Optional. Port number to expose. This must be a valid port number, between 1 and 65535.
+        "protocol": "A String", # Optional. Protocol for port. Defaults to TCP if not specified.
+      },
+    ],
+    "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Resource requests and limits for the container.
+      "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi").
+        "a_key": "A String",
+      },
+      "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi").
+        "a_key": "A String",
+      },
+    },
+  },
+  "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads.
+    "defaultContainerCategory": "A String", # Required. The category of the default container image.
+  },
+  "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+  "name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
+  "state": "A String", # Output only. The state of the sandbox environment template.
+  "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
+  "warmPoolConfig": { # Configuration for a warm pool of sandbox instances. # Optional. The configuration for the warm pool of this template.
+    "targetInstanceCount": 42, # Optional. The target number of pre-warmed instances to maintain.
+  },
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists SandboxEnvironmentTemplates in a given reasoning engine.
+
+Args:
+  parent: string, Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
+  pageSize: integer, Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned.
+  pageToken: string, Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page.
+  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 SandboxEnvironmentService.ListSandboxEnvironmentTemplates.
+  "nextPageToken": "A String", # A token, which can be sent as ListSandboxEnvironmentTemplatesRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.
+  "sandboxEnvironmentTemplates": [ # The SandboxEnvironmentTemplates matching the request.
+    { # The specification of a SandboxEnvironmentTemplate. A SandboxEnvironmentTemplate defines a template for creating SandboxEnvironments.
+      "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was created.
+      "customContainerEnvironment": { # The customized sandbox runtime environment for BYOC. # The sandbox environment for custom container workloads.
+        "customContainerSpec": { # Specification for deploying from a custom container image. # The specification of the custom container environment.
+          "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.
+        },
+        "ports": [ # Ports to expose from the container.
+          { # Represents a network port in a container.
+            "port": 42, # Optional. Port number to expose. This must be a valid port number, between 1 and 65535.
+            "protocol": "A String", # Optional. Protocol for port. Defaults to TCP if not specified.
+          },
+        ],
+        "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Resource requests and limits for the container.
+          "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi").
+            "a_key": "A String",
+          },
+          "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi").
+            "a_key": "A String",
+          },
+        },
+      },
+      "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads.
+        "defaultContainerCategory": "A String", # Required. The category of the default container image.
+      },
+      "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+      "name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
+      "state": "A String", # Output only. The state of the sandbox environment template.
+      "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
+      "warmPoolConfig": { # Configuration for a warm pool of sandbox instances. # Optional. The configuration for the warm pool of this template.
+        "targetInstanceCount": 42, # Optional. The target number of pre-warmed instances to maintain.
+      },
+    },
+  ],
+}
+
+ +
+ 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/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.html new file mode 100644 index 0000000000..d8453e5bc9 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.html @@ -0,0 +1,205 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . sandboxEnvironmentTemplates . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

+

+ 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.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ 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.
+  },
+}
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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_v1.projects.locations.reasoningEngines.sandboxEnvironments.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironments.html index 81bb2dcdd8..661329bf83 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironments.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sandboxEnvironments.html @@ -100,6 +100,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

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

+

Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.

Method Details

close() @@ -119,6 +122,7 @@

Method Details

"connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment. "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer. "loadBalancerIp": "A String", # Output only. The IP address of the load balancer. + "sandboxHostname": "A String", # Output only. The hostname of the SandboxEnvironment. "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment. }, "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created. @@ -264,6 +268,7 @@

Method Details

"connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment. "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer. "loadBalancerIp": "A String", # Output only. The IP address of the load balancer. + "sandboxHostname": "A String", # Output only. The hostname of the SandboxEnvironment. "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment. }, "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created. @@ -306,6 +311,7 @@

Method Details

"connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment. "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer. "loadBalancerIp": "A String", # Output only. The IP address of the load balancer. + "sandboxHostname": "A String", # Output only. The hostname of the SandboxEnvironment. "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment. }, "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created. @@ -340,4 +346,56 @@

Method Details

+
+ snapshot(name, body=None, x__xgafv=None) +
Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.
+
+Args:
+  name: string, Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # SandboxEnvironmentSnapshot is a snapshot of the SandboxEnvironment.
+  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentSnapshot was created.
+  "displayName": "A String", # Required. The display name of the SandboxEnvironmentSnapshot.
+  "expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironmentSnapshot is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+  "name": "A String", # Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
+  "owner": "A String", # Optional. Owner information for this sandbox snapshot. Different owners will have isolations on snapshot storage and identity. If not set, snapshot will be created as the default owner.
+  "parentSnapshot": "A String", # Output only. The resource name of the parent SandboxEnvironmentSnapshot. Empty if this is a root Snapshot (the first snapshot from a newly created sandbox). Can be used to reconstruct the whole ancestry tree of snapshots.
+  "postSnapshotAction": "A String", # Optional. Input only. Action to take on the source SandboxEnvironment after the snapshot is taken. This field is only used in CreateSandboxEnvironmentSnapshotRequest and it is not stored in the resource.
+  "sizeBytes": "A String", # Optional. Output only. Size of the snapshot data in bytes.
+  "sourceSandboxEnvironment": "A String", # Required. The resource name of the source SandboxEnvironment this snapshot was taken from.
+  "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently 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.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html index cf9e872b09..a8e9298291 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html @@ -639,6 +639,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -1724,6 +1729,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -2816,6 +2826,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -3914,6 +3929,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -5027,6 +5047,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` diff --git a/docs/dyn/aiplatform_v1.reasoningEngines.html b/docs/dyn/aiplatform_v1.reasoningEngines.html index 5a1e3a9697..d529ae827f 100644 --- a/docs/dyn/aiplatform_v1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1.reasoningEngines.html @@ -84,6 +84,21 @@

Instance Methods

Returns the operations Resource.

+

+ runtimeRevisions() +

+

Returns the runtimeRevisions Resource.

+ +

+ sandboxEnvironmentSnapshots() +

+

Returns the sandboxEnvironmentSnapshots Resource.

+ +

+ sandboxEnvironmentTemplates() +

+

Returns the sandboxEnvironmentTemplates Resource.

+

sandboxEnvironments()

@@ -142,17 +157,18 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Represents configuration for organizing memories for a particular scope. + { # Represents configuration for organizing natural language memories for a particular scope. "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. - "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + "revisionsPerCandidateCount": 42, # Optional. Represents the maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. }, - "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") - "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. + "disableNaturalLanguageMemories": True or False, # Optional. Indicates whether natural language memory generation should be disabled for all requests. By default, natural language memory generation is enabled. Set this to `true` when you only want to generate structured memories. + "enableThirdPersonMemories": True or False, # Optional. Indicates whether the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") + "generateMemoriesExamples": [ # Optional. Provides examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. "conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. - "events": [ # Optional. The input conversation events for the example. + "events": [ # Optional. Represents the input conversation events for the example. { # A single conversation event. - "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. + "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. Represents the content of the event. "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. @@ -229,38 +245,45 @@

Method Details

}, ], }, - "generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. + "generatedMemories": [ # Optional. Represents the memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. - "fact": "A String", # Required. The fact to generate a memory from. - "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + "fact": "A String", # Required. Represents the fact to generate a memory from. + "topics": [ # Optional. Represents the list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], }, ], }, ], - "memoryTopics": [ # Optional. Topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. + "memoryTopics": [ # Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. { # A topic of information that should be extracted from conversations and stored as memories. "customMemoryTopic": { # A custom memory topic defined by the developer. # A custom memory topic defined by the developer. - "description": "A String", # Required. Description of the memory topic. This should explain what information should be extracted for this topic. - "label": "A String", # Required. The label of the topic. + "description": "A String", # Required. Represents the description of the memory topic. This should explain what information should be extracted for this topic. + "label": "A String", # Required. Represents the label of the topic. }, "managedMemoryTopic": { # A managed memory topic defined by the system. # A managed memory topic defined by Memory Bank. - "managedTopicEnum": "A String", # Required. The managed topic. + "managedTopicEnum": "A String", # Required. Represents the managed topic. }, }, ], - "scopeKeys": [ # Optional. The scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. "A String", ], }, ], "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. - "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. + "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Specifies the default trigger configuration for generating memories using `IngestEvents`. + "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately. + "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. + "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. + "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + }, + }, + "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, "similaritySearchConfig": { # Configuration for how to perform similarity search on memories. # Optional. Configuration for how to perform similarity search on memories. If not set, the Memory Bank will use the default embedding model `text-embedding-005`. "embeddingModel": "A String", # Required. The model used to generate embeddings to lookup similar memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -513,17 +536,18 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Represents configuration for organizing memories for a particular scope. + { # Represents configuration for organizing natural language memories for a particular scope. "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. - "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + "revisionsPerCandidateCount": 42, # Optional. Represents the maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. }, - "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") - "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. + "disableNaturalLanguageMemories": True or False, # Optional. Indicates whether natural language memory generation should be disabled for all requests. By default, natural language memory generation is enabled. Set this to `true` when you only want to generate structured memories. + "enableThirdPersonMemories": True or False, # Optional. Indicates whether the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") + "generateMemoriesExamples": [ # Optional. Provides examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. "conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. - "events": [ # Optional. The input conversation events for the example. + "events": [ # Optional. Represents the input conversation events for the example. { # A single conversation event. - "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. + "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. Represents the content of the event. "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. @@ -600,38 +624,45 @@

Method Details

}, ], }, - "generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. + "generatedMemories": [ # Optional. Represents the memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. - "fact": "A String", # Required. The fact to generate a memory from. - "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + "fact": "A String", # Required. Represents the fact to generate a memory from. + "topics": [ # Optional. Represents the list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], }, ], }, ], - "memoryTopics": [ # Optional. Topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. + "memoryTopics": [ # Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. { # A topic of information that should be extracted from conversations and stored as memories. "customMemoryTopic": { # A custom memory topic defined by the developer. # A custom memory topic defined by the developer. - "description": "A String", # Required. Description of the memory topic. This should explain what information should be extracted for this topic. - "label": "A String", # Required. The label of the topic. + "description": "A String", # Required. Represents the description of the memory topic. This should explain what information should be extracted for this topic. + "label": "A String", # Required. Represents the label of the topic. }, "managedMemoryTopic": { # A managed memory topic defined by the system. # A managed memory topic defined by Memory Bank. - "managedTopicEnum": "A String", # Required. The managed topic. + "managedTopicEnum": "A String", # Required. Represents the managed topic. }, }, ], - "scopeKeys": [ # Optional. The scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. "A String", ], }, ], "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. - "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. + "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Specifies the default trigger configuration for generating memories using `IngestEvents`. + "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately. + "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. + "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. + "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + }, + }, + "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, "similaritySearchConfig": { # Configuration for how to perform similarity search on memories. # Optional. Configuration for how to perform similarity search on memories. If not set, the Memory Bank will use the default embedding model `text-embedding-005`. "embeddingModel": "A String", # Required. The model used to generate embeddings to lookup similar memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -779,17 +810,18 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Represents configuration for organizing memories for a particular scope. + { # Represents configuration for organizing natural language memories for a particular scope. "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. - "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + "revisionsPerCandidateCount": 42, # Optional. Represents the maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. }, - "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") - "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. + "disableNaturalLanguageMemories": True or False, # Optional. Indicates whether natural language memory generation should be disabled for all requests. By default, natural language memory generation is enabled. Set this to `true` when you only want to generate structured memories. + "enableThirdPersonMemories": True or False, # Optional. Indicates whether the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") + "generateMemoriesExamples": [ # Optional. Provides examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. "conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. - "events": [ # Optional. The input conversation events for the example. + "events": [ # Optional. Represents the input conversation events for the example. { # A single conversation event. - "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. + "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. Represents the content of the event. "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. @@ -866,38 +898,45 @@

Method Details

}, ], }, - "generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. + "generatedMemories": [ # Optional. Represents the memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. - "fact": "A String", # Required. The fact to generate a memory from. - "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + "fact": "A String", # Required. Represents the fact to generate a memory from. + "topics": [ # Optional. Represents the list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], }, ], }, ], - "memoryTopics": [ # Optional. Topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. + "memoryTopics": [ # Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. { # A topic of information that should be extracted from conversations and stored as memories. "customMemoryTopic": { # A custom memory topic defined by the developer. # A custom memory topic defined by the developer. - "description": "A String", # Required. Description of the memory topic. This should explain what information should be extracted for this topic. - "label": "A String", # Required. The label of the topic. + "description": "A String", # Required. Represents the description of the memory topic. This should explain what information should be extracted for this topic. + "label": "A String", # Required. Represents the label of the topic. }, "managedMemoryTopic": { # A managed memory topic defined by the system. # A managed memory topic defined by Memory Bank. - "managedTopicEnum": "A String", # Required. The managed topic. + "managedTopicEnum": "A String", # Required. Represents the managed topic. }, }, ], - "scopeKeys": [ # Optional. The scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. "A String", ], }, ], "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. - "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. + "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Specifies the default trigger configuration for generating memories using `IngestEvents`. + "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately. + "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. + "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. + "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + }, + }, + "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, "similaritySearchConfig": { # Configuration for how to perform similarity search on memories. # Optional. Configuration for how to perform similarity search on memories. If not set, the Memory Bank will use the default embedding model `text-embedding-005`. "embeddingModel": "A String", # Required. The model used to generate embeddings to lookup similar memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -1050,17 +1089,18 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Represents configuration for organizing memories for a particular scope. + { # Represents configuration for organizing natural language memories for a particular scope. "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. - "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + "revisionsPerCandidateCount": 42, # Optional. Represents the maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. }, - "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") - "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. + "disableNaturalLanguageMemories": True or False, # Optional. Indicates whether natural language memory generation should be disabled for all requests. By default, natural language memory generation is enabled. Set this to `true` when you only want to generate structured memories. + "enableThirdPersonMemories": True or False, # Optional. Indicates whether the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") + "generateMemoriesExamples": [ # Optional. Provides examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. "conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. - "events": [ # Optional. The input conversation events for the example. + "events": [ # Optional. Represents the input conversation events for the example. { # A single conversation event. - "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. + "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. Represents the content of the event. "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. @@ -1137,38 +1177,45 @@

Method Details

}, ], }, - "generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. + "generatedMemories": [ # Optional. Represents the memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. - "fact": "A String", # Required. The fact to generate a memory from. - "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + "fact": "A String", # Required. Represents the fact to generate a memory from. + "topics": [ # Optional. Represents the list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], }, ], }, ], - "memoryTopics": [ # Optional. Topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. + "memoryTopics": [ # Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. { # A topic of information that should be extracted from conversations and stored as memories. "customMemoryTopic": { # A custom memory topic defined by the developer. # A custom memory topic defined by the developer. - "description": "A String", # Required. Description of the memory topic. This should explain what information should be extracted for this topic. - "label": "A String", # Required. The label of the topic. + "description": "A String", # Required. Represents the description of the memory topic. This should explain what information should be extracted for this topic. + "label": "A String", # Required. Represents the label of the topic. }, "managedMemoryTopic": { # A managed memory topic defined by the system. # A managed memory topic defined by Memory Bank. - "managedTopicEnum": "A String", # Required. The managed topic. + "managedTopicEnum": "A String", # Required. Represents the managed topic. }, }, ], - "scopeKeys": [ # Optional. The scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. "A String", ], }, ], "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. - "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. + "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Specifies the default trigger configuration for generating memories using `IngestEvents`. + "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately. + "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. + "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. + "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + }, + }, + "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, "similaritySearchConfig": { # Configuration for how to perform similarity search on memories. # Optional. Configuration for how to perform similarity search on memories. If not set, the Memory Bank will use the default embedding model `text-embedding-005`. "embeddingModel": "A String", # Required. The model used to generate embeddings to lookup similar memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. diff --git a/docs/dyn/aiplatform_v1.reasoningEngines.runtimeRevisions.html b/docs/dyn/aiplatform_v1.reasoningEngines.runtimeRevisions.html new file mode 100644 index 0000000000..5b118d08c5 --- /dev/null +++ b/docs/dyn/aiplatform_v1.reasoningEngines.runtimeRevisions.html @@ -0,0 +1,156 @@ + + + +

Vertex AI API . reasoningEngines . runtimeRevisions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Queries using a reasoning engine.

+

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

+

Streams queries using a reasoning engine.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ query(name, body=None, x__xgafv=None) +
Queries using a reasoning engine.
+
+Args:
+  name: string, Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ReasoningEngineExecutionService.Query.
+  "classMethod": "A String", # Optional. Class method to be used for the query. It is optional and defaults to "query" if unspecified.
+  "input": { # Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+  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 ReasoningEngineExecutionService.Query
+  "output": "", # Response provided by users in JSON object format.
+}
+
+ +
+ streamQuery(name, body=None, x__xgafv=None) +
Streams queries using a reasoning engine.
+
+Args:
+  name: string, Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ReasoningEngineExecutionService.StreamQuery.
+  "classMethod": "A String", # Optional. Class method to be used for the stream query. It is optional and defaults to "stream_query" if unspecified.
+  "input": { # Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentSnapshots.html b/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentSnapshots.html new file mode 100644 index 0000000000..e349fcd838 --- /dev/null +++ b/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentSnapshots.html @@ -0,0 +1,218 @@ + + + +

Vertex AI API . reasoningEngines . sandboxEnvironmentSnapshots

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes the specific SandboxEnvironmentSnapshot.

+

+ get(name, x__xgafv=None)

+

Gets details of the specific SandboxEnvironmentSnapshot.

+

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

+

Lists SandboxEnvironmentSnapshots in a given reasoning engine.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes the specific SandboxEnvironmentSnapshot.
+
+Args:
+  name: string, Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}` (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 the specific SandboxEnvironmentSnapshot.
+
+Args:
+  name: string, Required. The resource name of the sandbox environment snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # SandboxEnvironmentSnapshot is a snapshot of the SandboxEnvironment.
+  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentSnapshot was created.
+  "displayName": "A String", # Required. The display name of the SandboxEnvironmentSnapshot.
+  "expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironmentSnapshot is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+  "name": "A String", # Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
+  "owner": "A String", # Optional. Owner information for this sandbox snapshot. Different owners will have isolations on snapshot storage and identity. If not set, snapshot will be created as the default owner.
+  "parentSnapshot": "A String", # Output only. The resource name of the parent SandboxEnvironmentSnapshot. Empty if this is a root Snapshot (the first snapshot from a newly created sandbox). Can be used to reconstruct the whole ancestry tree of snapshots.
+  "postSnapshotAction": "A String", # Optional. Input only. Action to take on the source SandboxEnvironment after the snapshot is taken. This field is only used in CreateSandboxEnvironmentSnapshotRequest and it is not stored in the resource.
+  "sizeBytes": "A String", # Optional. Output only. Size of the snapshot data in bytes.
+  "sourceSandboxEnvironment": "A String", # Required. The resource name of the source SandboxEnvironment this snapshot was taken from.
+  "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently updated.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists SandboxEnvironmentSnapshots in a given reasoning engine.
+
+Args:
+  parent: string, Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
+  pageSize: integer, Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100.
+  pageToken: string, Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page.
+  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 SandboxEnvironmentService.ListSandboxEnvironmentSnapshots.
+  "nextPageToken": "A String", # A token, which can be sent as ListSandboxEnvironmentSnapshotsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.
+  "sandboxEnvironmentSnapshots": [ # The SandboxEnvironmentSnapshots matching the request.
+    { # SandboxEnvironmentSnapshot is a snapshot of the SandboxEnvironment.
+      "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentSnapshot was created.
+      "displayName": "A String", # Required. The display name of the SandboxEnvironmentSnapshot.
+      "expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironmentSnapshot is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+      "name": "A String", # Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
+      "owner": "A String", # Optional. Owner information for this sandbox snapshot. Different owners will have isolations on snapshot storage and identity. If not set, snapshot will be created as the default owner.
+      "parentSnapshot": "A String", # Output only. The resource name of the parent SandboxEnvironmentSnapshot. Empty if this is a root Snapshot (the first snapshot from a newly created sandbox). Can be used to reconstruct the whole ancestry tree of snapshots.
+      "postSnapshotAction": "A String", # Optional. Input only. Action to take on the source SandboxEnvironment after the snapshot is taken. This field is only used in CreateSandboxEnvironmentSnapshotRequest and it is not stored in the resource.
+      "sizeBytes": "A String", # Optional. Output only. Size of the snapshot data in bytes.
+      "sourceSandboxEnvironment": "A String", # Required. The resource name of the source SandboxEnvironment this snapshot was taken from.
+      "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.
+      "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently 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.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentSnapshots.operations.html b/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentSnapshots.operations.html new file mode 100644 index 0000000000..3f1a076816 --- /dev/null +++ b/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentSnapshots.operations.html @@ -0,0 +1,205 @@ + + + +

Vertex AI API . reasoningEngines . sandboxEnvironmentSnapshots . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

+

+ 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.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ 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.
+  },
+}
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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_v1.reasoningEngines.sandboxEnvironmentTemplates.html b/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentTemplates.html new file mode 100644 index 0000000000..95a5352a33 --- /dev/null +++ b/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentTemplates.html @@ -0,0 +1,330 @@ + + + +

Vertex AI API . reasoningEngines . sandboxEnvironmentTemplates

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates a SandboxEnvironmentTemplate in a given reasoning engine.

+

+ delete(name, x__xgafv=None)

+

Deletes the specific SandboxEnvironmentTemplate.

+

+ get(name, x__xgafv=None)

+

Gets details of the specific SandboxEnvironmentTemplate.

+

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

+

Lists SandboxEnvironmentTemplates in a given reasoning engine.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a SandboxEnvironmentTemplate in a given reasoning engine.
+
+Args:
+  parent: string, Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The specification of a SandboxEnvironmentTemplate. A SandboxEnvironmentTemplate defines a template for creating SandboxEnvironments.
+  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was created.
+  "customContainerEnvironment": { # The customized sandbox runtime environment for BYOC. # The sandbox environment for custom container workloads.
+    "customContainerSpec": { # Specification for deploying from a custom container image. # The specification of the custom container environment.
+      "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.
+    },
+    "ports": [ # Ports to expose from the container.
+      { # Represents a network port in a container.
+        "port": 42, # Optional. Port number to expose. This must be a valid port number, between 1 and 65535.
+        "protocol": "A String", # Optional. Protocol for port. Defaults to TCP if not specified.
+      },
+    ],
+    "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Resource requests and limits for the container.
+      "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi").
+        "a_key": "A String",
+      },
+      "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi").
+        "a_key": "A String",
+      },
+    },
+  },
+  "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads.
+    "defaultContainerCategory": "A String", # Required. The category of the default container image.
+  },
+  "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+  "name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
+  "state": "A String", # Output only. The state of the sandbox environment template.
+  "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
+  "warmPoolConfig": { # Configuration for a warm pool of sandbox instances. # Optional. The configuration for the warm pool of this template.
+    "targetInstanceCount": 42, # Optional. The target number of pre-warmed instances to maintain.
+  },
+}
+
+  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 the specific SandboxEnvironmentTemplate.
+
+Args:
+  name: string, Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` (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 the specific SandboxEnvironmentTemplate.
+
+Args:
+  name: string, Required. The resource name of the sandbox environment template. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The specification of a SandboxEnvironmentTemplate. A SandboxEnvironmentTemplate defines a template for creating SandboxEnvironments.
+  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was created.
+  "customContainerEnvironment": { # The customized sandbox runtime environment for BYOC. # The sandbox environment for custom container workloads.
+    "customContainerSpec": { # Specification for deploying from a custom container image. # The specification of the custom container environment.
+      "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.
+    },
+    "ports": [ # Ports to expose from the container.
+      { # Represents a network port in a container.
+        "port": 42, # Optional. Port number to expose. This must be a valid port number, between 1 and 65535.
+        "protocol": "A String", # Optional. Protocol for port. Defaults to TCP if not specified.
+      },
+    ],
+    "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Resource requests and limits for the container.
+      "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi").
+        "a_key": "A String",
+      },
+      "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi").
+        "a_key": "A String",
+      },
+    },
+  },
+  "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads.
+    "defaultContainerCategory": "A String", # Required. The category of the default container image.
+  },
+  "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+  "name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
+  "state": "A String", # Output only. The state of the sandbox environment template.
+  "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
+  "warmPoolConfig": { # Configuration for a warm pool of sandbox instances. # Optional. The configuration for the warm pool of this template.
+    "targetInstanceCount": 42, # Optional. The target number of pre-warmed instances to maintain.
+  },
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists SandboxEnvironmentTemplates in a given reasoning engine.
+
+Args:
+  parent: string, Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
+  pageSize: integer, Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned.
+  pageToken: string, Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page.
+  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 SandboxEnvironmentService.ListSandboxEnvironmentTemplates.
+  "nextPageToken": "A String", # A token, which can be sent as ListSandboxEnvironmentTemplatesRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.
+  "sandboxEnvironmentTemplates": [ # The SandboxEnvironmentTemplates matching the request.
+    { # The specification of a SandboxEnvironmentTemplate. A SandboxEnvironmentTemplate defines a template for creating SandboxEnvironments.
+      "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was created.
+      "customContainerEnvironment": { # The customized sandbox runtime environment for BYOC. # The sandbox environment for custom container workloads.
+        "customContainerSpec": { # Specification for deploying from a custom container image. # The specification of the custom container environment.
+          "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.
+        },
+        "ports": [ # Ports to expose from the container.
+          { # Represents a network port in a container.
+            "port": 42, # Optional. Port number to expose. This must be a valid port number, between 1 and 65535.
+            "protocol": "A String", # Optional. Protocol for port. Defaults to TCP if not specified.
+          },
+        ],
+        "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Resource requests and limits for the container.
+          "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi").
+            "a_key": "A String",
+          },
+          "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi").
+            "a_key": "A String",
+          },
+        },
+      },
+      "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads.
+        "defaultContainerCategory": "A String", # Required. The category of the default container image.
+      },
+      "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+      "name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
+      "state": "A String", # Output only. The state of the sandbox environment template.
+      "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
+      "warmPoolConfig": { # Configuration for a warm pool of sandbox instances. # Optional. The configuration for the warm pool of this template.
+        "targetInstanceCount": 42, # Optional. The target number of pre-warmed instances to maintain.
+      },
+    },
+  ],
+}
+
+ +
+ 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/aiplatform_v1.reasoningEngines.sandboxEnvironmentTemplates.operations.html b/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentTemplates.operations.html new file mode 100644 index 0000000000..71f06d5c2d --- /dev/null +++ b/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironmentTemplates.operations.html @@ -0,0 +1,205 @@ + + + +

Vertex AI API . reasoningEngines . sandboxEnvironmentTemplates . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

+

+ 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.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ 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.
+  },
+}
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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_v1.reasoningEngines.sandboxEnvironments.html b/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironments.html index a09597cc0f..55b8be9848 100644 --- a/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironments.html +++ b/docs/dyn/aiplatform_v1.reasoningEngines.sandboxEnvironments.html @@ -100,6 +100,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

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

+

Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.

Method Details

close() @@ -119,6 +122,7 @@

Method Details

"connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment. "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer. "loadBalancerIp": "A String", # Output only. The IP address of the load balancer. + "sandboxHostname": "A String", # Output only. The hostname of the SandboxEnvironment. "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment. }, "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created. @@ -264,6 +268,7 @@

Method Details

"connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment. "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer. "loadBalancerIp": "A String", # Output only. The IP address of the load balancer. + "sandboxHostname": "A String", # Output only. The hostname of the SandboxEnvironment. "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment. }, "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created. @@ -306,6 +311,7 @@

Method Details

"connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment. "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer. "loadBalancerIp": "A String", # Output only. The IP address of the load balancer. + "sandboxHostname": "A String", # Output only. The hostname of the SandboxEnvironment. "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment. }, "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created. @@ -340,4 +346,56 @@

Method Details

+
+ snapshot(name, body=None, x__xgafv=None) +
Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.
+
+Args:
+  name: string, Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # SandboxEnvironmentSnapshot is a snapshot of the SandboxEnvironment.
+  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentSnapshot was created.
+  "displayName": "A String", # Required. The display name of the SandboxEnvironmentSnapshot.
+  "expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironmentSnapshot is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+  "name": "A String", # Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
+  "owner": "A String", # Optional. Owner information for this sandbox snapshot. Different owners will have isolations on snapshot storage and identity. If not set, snapshot will be created as the default owner.
+  "parentSnapshot": "A String", # Output only. The resource name of the parent SandboxEnvironmentSnapshot. Empty if this is a root Snapshot (the first snapshot from a newly created sandbox). Can be used to reconstruct the whole ancestry tree of snapshots.
+  "postSnapshotAction": "A String", # Optional. Input only. Action to take on the source SandboxEnvironment after the snapshot is taken. This field is only used in CreateSandboxEnvironmentSnapshotRequest and it is not stored in the resource.
+  "sizeBytes": "A String", # Optional. Output only. Size of the snapshot data in bytes.
+  "sourceSandboxEnvironment": "A String", # Required. The resource name of the source SandboxEnvironment this snapshot was taken from.
+  "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently 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.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.v1.html b/docs/dyn/aiplatform_v1.v1.html index 525dbe0b2e..006db3aa0a 100644 --- a/docs/dyn/aiplatform_v1.v1.html +++ b/docs/dyn/aiplatform_v1.v1.html @@ -378,6 +378,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -2578,6 +2583,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -2897,6 +2907,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html index 1a3fcd928b..3a13ad6eed 100644 --- a/docs/dyn/aiplatform_v1beta1.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.endpoints.html @@ -1477,6 +1477,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. @@ -2394,6 +2396,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/aiplatform_v1beta1.html b/docs/dyn/aiplatform_v1beta1.html index 4d5bd735d8..5e2600ea30 100644 --- a/docs/dyn/aiplatform_v1beta1.html +++ b/docs/dyn/aiplatform_v1beta1.html @@ -234,6 +234,11 @@

Instance Methods

Returns the notebookRuntimes Resource.

+

+ onlineEvaluators() +

+

Returns the onlineEvaluators Resource.

+

operations()

diff --git a/docs/dyn/aiplatform_v1beta1.onlineEvaluators.html b/docs/dyn/aiplatform_v1beta1.onlineEvaluators.html new file mode 100644 index 0000000000..bc798f931d --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.onlineEvaluators.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . onlineEvaluators

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.onlineEvaluators.operations.html b/docs/dyn/aiplatform_v1beta1.onlineEvaluators.operations.html new file mode 100644 index 0000000000..fd4b8b4a1d --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.onlineEvaluators.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . onlineEvaluators . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

+

+ 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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ 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.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # 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.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
+    "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.
+        
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index 2139008c04..8018dd2bc7 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -2644,6 +2644,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. @@ -5306,6 +5308,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/aiplatform_v1beta1.projects.locations.evaluationMetrics.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html index d4c1d6efb8..cdc1c60a0d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html @@ -120,7 +120,7 @@

Method Details

"labels": { # Optional. Labels for the evaluation metric. "a_key": "A String", }, - "metric": { # The metric used for running evaluations. # Optional. The metric configuration. + "metric": { # The metric used for running evaluations. # Optional. The metric configuration. Only LLMMetric and CustomCodeExecutionMetric are supported. "aggregationMetrics": [ # Optional. The aggregation metrics to use. "A String", ], @@ -270,6 +270,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -462,7 +467,7 @@

Method Details

"labels": { # Optional. Labels for the evaluation metric. "a_key": "A String", }, - "metric": { # The metric used for running evaluations. # Optional. The metric configuration. + "metric": { # The metric used for running evaluations. # Optional. The metric configuration. Only LLMMetric and CustomCodeExecutionMetric are supported. "aggregationMetrics": [ # Optional. The aggregation metrics to use. "A String", ], @@ -612,6 +617,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -845,7 +855,7 @@

Method Details

"labels": { # Optional. Labels for the evaluation metric. "a_key": "A String", }, - "metric": { # The metric used for running evaluations. # Optional. The metric configuration. + "metric": { # The metric used for running evaluations. # Optional. The metric configuration. Only LLMMetric and CustomCodeExecutionMetric are supported. "aggregationMetrics": [ # Optional. The aggregation metrics to use. "A String", ], @@ -995,6 +1005,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -1199,7 +1214,7 @@

Method Details

"labels": { # Optional. Labels for the evaluation metric. "a_key": "A String", }, - "metric": { # The metric used for running evaluations. # Optional. The metric configuration. + "metric": { # The metric used for running evaluations. # Optional. The metric configuration. Only LLMMetric and CustomCodeExecutionMetric are supported. "aggregationMetrics": [ # Optional. The aggregation metrics to use. "A String", ], @@ -1349,6 +1364,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html index 8d8d4f0cd1..28d36d2cda 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html @@ -722,6 +722,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -4123,6 +4128,7 @@

Method Details

"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. }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. }, }, "labels": { # Optional. Labels for the evaluation run. @@ -4724,6 +4730,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -8125,6 +8136,7 @@

Method Details

"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. }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. }, }, "labels": { # Optional. Labels for the evaluation run. @@ -8768,6 +8780,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -12169,6 +12186,7 @@

Method Details

"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. }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. }, }, "labels": { # Optional. Labels for the evaluation run. @@ -12783,6 +12801,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -16184,6 +16207,7 @@

Method Details

"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. }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. }, }, "labels": { # Optional. Labels for the evaluation run. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html index 0f5fdb59db..5fae42f502 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html @@ -116,6 +116,240 @@

Method Details

The object takes the form of: { # EvaluationSet is a collection of related EvaluationItems that are evaluated together. + "agentConfigs": { # Optional. Static configurations for each agent associated with the items in this set. 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. + }, + }, + ], + }, + }, "createTime": "A String", # Output only. Timestamp when this item was created. "displayName": "A String", # Required. The display name of the EvaluationSet. "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset. @@ -135,6 +369,240 @@

Method Details

An object of the form: { # EvaluationSet is a collection of related EvaluationItems that are evaluated together. + "agentConfigs": { # Optional. Static configurations for each agent associated with the items in this set. 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. + }, + }, + ], + }, + }, "createTime": "A String", # Output only. Timestamp when this item was created. "displayName": "A String", # Required. The display name of the EvaluationSet. "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset. @@ -196,6 +664,240 @@

Method Details

An object of the form: { # EvaluationSet is a collection of related EvaluationItems that are evaluated together. + "agentConfigs": { # Optional. Static configurations for each agent associated with the items in this set. 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. + }, + }, + ], + }, + }, "createTime": "A String", # Output only. Timestamp when this item was created. "displayName": "A String", # Required. The display name of the EvaluationSet. "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset. @@ -228,6 +930,240 @@

Method Details

{ # Response message for EvaluationManagementService.ListEvaluationSets. "evaluationSets": [ # List of EvaluationSets in the requested page. { # EvaluationSet is a collection of related EvaluationItems that are evaluated together. + "agentConfigs": { # Optional. Static configurations for each agent associated with the items in this set. 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. + }, + }, + ], + }, + }, "createTime": "A String", # Output only. Timestamp when this item was created. "displayName": "A String", # Required. The display name of the EvaluationSet. "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset. @@ -266,6 +1202,240 @@

Method Details

The object takes the form of: { # EvaluationSet is a collection of related EvaluationItems that are evaluated together. + "agentConfigs": { # Optional. Static configurations for each agent associated with the items in this set. 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. + }, + }, + ], + }, + }, "createTime": "A String", # Output only. Timestamp when this item was created. "displayName": "A String", # Required. The display name of the EvaluationSet. "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset. @@ -286,6 +1456,240 @@

Method Details

An object of the form: { # EvaluationSet is a collection of related EvaluationItems that are evaluated together. + "agentConfigs": { # Optional. Static configurations for each agent associated with the items in this set. 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. + }, + }, + ], + }, + }, "createTime": "A String", # Output only. Timestamp when this item was created. "displayName": "A String", # Required. The display name of the EvaluationSet. "evaluationItems": [ # Required. The EvaluationItems that are part of this dataset. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index 0ee2866565..15dca44461 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -654,6 +654,8 @@

Method Details

"contexts": [ # All its contexts. { # A context of the query. "chunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Context of the retrieved chunk. + "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. @@ -1182,6 +1184,8 @@

Method Details

"facts": [ # Retrieved facts from RAG data sources. { # The fact used in grounding. "chunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # If present, chunk properties. + "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. @@ -1293,6 +1297,8 @@

Method Details

"facts": [ # Optional. Facts used to generate the text can also be used to corroborate the text. { # The fact used in grounding. "chunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # If present, chunk properties. + "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. @@ -1965,6 +1971,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -4771,6 +4782,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -5096,6 +5112,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -9609,6 +9630,8 @@

Method Details

"contexts": [ # All its contexts. { # A context of the query. "chunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Context of the retrieved chunk. + "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/aiplatform_v1beta1.projects.locations.onlineEvaluators.html b/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.html index 75dd7ea1d9..96fe96545b 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.html @@ -74,6 +74,11 @@

Vertex AI API . projects . locations . onlineEvaluators

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+

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

Activates an OnlineEvaluator.

@@ -164,8 +169,8 @@

Method Details

"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. + "traceScope": { # If chosen, the online evaluator will evaluate single traces matching specified `filter`. # Scope online evaluation to single traces. + "filter": [ # Optional. A list of predicates to filter traces. Multiple predicates are combined using AND. The maximum number of predicates is 10. { # 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. @@ -183,12 +188,12 @@

Method Details

"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. + "percentage": 42, # Required. The percentage of traces to sample for evaluation. Must be an integer between `1` 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. + "metricSources": [ # Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided. Right now, only predefined metrics and registered metrics are supported. Every registered metric must have `display_name` (or `title`) and `score_range` defined. Otherwise, the evaluations will fail. The maximum number of `metric_sources` is 25. { # The metric source used for evaluation. "metric": { # The metric used for running evaluations. # Inline metric config. "aggregationMetrics": [ # Optional. The aggregation metrics to use. @@ -340,6 +345,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -516,6 +526,11 @@

Method Details

], "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. + "stateDetails": [ # Output only. Contains additional information about the state of the OnlineEvaluator. This is used to provide more details in the event of a failure. + { # Contains additional information about the state of the OnlineEvaluator. + "message": "A String", # Output only. Human-readable message describing the state of the OnlineEvaluator. + }, + ], "updateTime": "A String", # Output only. Timestamp when the OnlineEvaluator was last updated. } @@ -604,8 +619,8 @@

Method Details

"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. + "traceScope": { # If chosen, the online evaluator will evaluate single traces matching specified `filter`. # Scope online evaluation to single traces. + "filter": [ # Optional. A list of predicates to filter traces. Multiple predicates are combined using AND. The maximum number of predicates is 10. { # 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. @@ -623,12 +638,12 @@

Method Details

"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. + "percentage": 42, # Required. The percentage of traces to sample for evaluation. Must be an integer between `1` 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. + "metricSources": [ # Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided. Right now, only predefined metrics and registered metrics are supported. Every registered metric must have `display_name` (or `title`) and `score_range` defined. Otherwise, the evaluations will fail. The maximum number of `metric_sources` is 25. { # The metric source used for evaluation. "metric": { # The metric used for running evaluations. # Inline metric config. "aggregationMetrics": [ # Optional. The aggregation metrics to use. @@ -780,6 +795,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -956,6 +976,11 @@

Method Details

], "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. + "stateDetails": [ # Output only. Contains additional information about the state of the OnlineEvaluator. This is used to provide more details in the event of a failure. + { # Contains additional information about the state of the OnlineEvaluator. + "message": "A String", # Output only. Human-readable message describing the state of the OnlineEvaluator. + }, + ], "updateTime": "A String", # Output only. Timestamp when the OnlineEvaluator was last updated. } @@ -988,8 +1013,8 @@

Method Details

"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. + "traceScope": { # If chosen, the online evaluator will evaluate single traces matching specified `filter`. # Scope online evaluation to single traces. + "filter": [ # Optional. A list of predicates to filter traces. Multiple predicates are combined using AND. The maximum number of predicates is 10. { # 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. @@ -1007,12 +1032,12 @@

Method Details

"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. + "percentage": 42, # Required. The percentage of traces to sample for evaluation. Must be an integer between `1` 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. + "metricSources": [ # Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided. Right now, only predefined metrics and registered metrics are supported. Every registered metric must have `display_name` (or `title`) and `score_range` defined. Otherwise, the evaluations will fail. The maximum number of `metric_sources` is 25. { # The metric source used for evaluation. "metric": { # The metric used for running evaluations. # Inline metric config. "aggregationMetrics": [ # Optional. The aggregation metrics to use. @@ -1164,6 +1189,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -1340,6 +1370,11 @@

Method Details

], "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. + "stateDetails": [ # Output only. Contains additional information about the state of the OnlineEvaluator. This is used to provide more details in the event of a failure. + { # Contains additional information about the state of the OnlineEvaluator. + "message": "A String", # Output only. Human-readable message describing the state of the OnlineEvaluator. + }, + ], "updateTime": "A String", # Output only. Timestamp when the OnlineEvaluator was last updated. }, ], @@ -1376,8 +1411,8 @@

Method Details

"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. + "traceScope": { # If chosen, the online evaluator will evaluate single traces matching specified `filter`. # Scope online evaluation to single traces. + "filter": [ # Optional. A list of predicates to filter traces. Multiple predicates are combined using AND. The maximum number of predicates is 10. { # 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. @@ -1395,12 +1430,12 @@

Method Details

"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. + "percentage": 42, # Required. The percentage of traces to sample for evaluation. Must be an integer between `1` 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. + "metricSources": [ # Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided. Right now, only predefined metrics and registered metrics are supported. Every registered metric must have `display_name` (or `title`) and `score_range` defined. Otherwise, the evaluations will fail. The maximum number of `metric_sources` is 25. { # The metric source used for evaluation. "metric": { # The metric used for running evaluations. # Inline metric config. "aggregationMetrics": [ # Optional. The aggregation metrics to use. @@ -1552,6 +1587,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -1728,6 +1768,11 @@

Method Details

], "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. + "stateDetails": [ # Output only. Contains additional information about the state of the OnlineEvaluator. This is used to provide more details in the event of a failure. + { # Contains additional information about the state of the OnlineEvaluator. + "message": "A String", # Output only. Human-readable message describing the state of the OnlineEvaluator. + }, + ], "updateTime": "A String", # Output only. Timestamp when the OnlineEvaluator was last updated. } diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.operations.html new file mode 100644 index 0000000000..d3b82be5eb --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . projects . locations . onlineEvaluators . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

+

+ 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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ 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.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # 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.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
+    "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.
+        
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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 5bd9c53a4a..1e34f4b517 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -1720,6 +1720,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. @@ -2953,6 +2955,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/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.html index 2ba2b2a9b9..948afd2d52 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.html @@ -594,7 +594,7 @@

Method Details

"updateTime": "A String", # Output only. The last update timestamp of the task. } - a2aTaskId: string, Required. User-defined ID of the A2aTask. This ID must be unique within the ReasoningEngine. + a2aTaskId: string, Required. User-defined ID of the A2aTask. This ID must be unique within the ReasoningEngine. It must be 1-63 characters, start with a lowercase letter or number, end with a lowercase letter or number, and only contain lowercase letters, numbers, and hyphens [AIP-122](https://google.aip.dev/122). Starting with a number is allowed for compatibility with the auto-generated UUID from A2A SDK. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html index 2ff44d4461..ac23279a57 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html @@ -109,6 +109,16 @@

Instance Methods

Returns the runtimeRevisions Resource.

+

+ sandboxEnvironmentSnapshots() +

+

Returns the sandboxEnvironmentSnapshots Resource.

+ +

+ sandboxEnvironmentTemplates() +

+

Returns the sandboxEnvironmentTemplates Resource.

+

sandboxEnvironments()

@@ -177,17 +187,18 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Represents configuration for organizing memories for a particular scope. + { # Represents configuration for organizing natural language memories for a particular scope. "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. - "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + "revisionsPerCandidateCount": 42, # Optional. Represents the maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. }, - "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") - "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. + "disableNaturalLanguageMemories": True or False, # Optional. Indicates whether natural language memory generation should be disabled for all requests. By default, natural language memory generation is enabled. Set this to `true` when you only want to generate structured memories. + "enableThirdPersonMemories": True or False, # Optional. Indicates whether the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") + "generateMemoriesExamples": [ # Optional. Provides examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. "conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. - "events": [ # Optional. The input conversation events for the example. + "events": [ # Optional. Represents the input conversation events for the example. { # A single conversation event. - "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. + "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. Represents the content of the event. "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. @@ -266,42 +277,101 @@

Method Details

}, ], }, - "generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. + "generatedMemories": [ # Optional. Represents the memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. - "fact": "A String", # Required. The fact to generate a memory from. - "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + "fact": "A String", # Required. Represents the fact to generate a memory from. + "topics": [ # Optional. Represents the list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], }, ], }, ], - "memoryTopics": [ # Optional. Topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. + "memoryTopics": [ # Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. { # A topic of information that should be extracted from conversations and stored as memories. "customMemoryTopic": { # A custom memory topic defined by the developer. # A custom memory topic defined by the developer. - "description": "A String", # Required. Description of the memory topic. This should explain what information should be extracted for this topic. - "label": "A String", # Required. The label of the topic. + "description": "A String", # Required. Represents the description of the memory topic. This should explain what information should be extracted for this topic. + "label": "A String", # Required. Represents the label of the topic. }, "managedMemoryTopic": { # A managed memory topic defined by the system. # A managed memory topic defined by Memory Bank. - "managedTopicEnum": "A String", # Required. The managed topic. + "managedTopicEnum": "A String", # Required. Represents the managed topic. }, }, ], - "scopeKeys": [ # Optional. The scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. "A String", ], }, ], "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. - "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. + "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Specifies the default trigger configuration for generating memories using `IngestEvents`. + "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately. + "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. + "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. + "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + }, + }, + "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, "similaritySearchConfig": { # Configuration for how to perform similarity search on memories. # Optional. Configuration for how to perform similarity search on memories. If not set, the Memory Bank will use the default embedding model `text-embedding-005`. "embeddingModel": "A String", # Required. The model used to generate embeddings to lookup similar memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, + "structuredMemoryConfigs": [ # Optional. Configuration for organizing structured memories for a particular scope. + { # Represents configuration for organizing structured memories for a particular scope. + "schemaConfigs": [ # Optional. Represents configuration of the structured memories' schemas. + { # Schema configuration for structured memories. + "id": "A String", # Required. Represents the ID of the schema. Must be 1-63 characters, start with a lowercase letter, and consist of lowercase letters, numbers, and hyphens. + "memoryType": "A String", # Optional. Represents the type of the structured memories associated with the schema. If not set, then `STRUCTURED_PROFILE` will be used. + "schema": { # 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). # Required. Represents the OpenAPI schema of the structured memories. The schema `type` cannot be `ARRAY` when `memory_type` is `STRUCTURED_PROFILE`. + "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. + }, + }, + ], + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "A String", + ], + }, + ], "ttlConfig": { # Configuration for automatically setting the TTL ("time-to-live") of the memories in the Memory Bank. # Optional. Configuration for automatic TTL ("time-to-live") of the memories in the Memory Bank. If not set, TTL will not be applied automatically. The TTL can be explicitly set by modifying the `expire_time` of each Memory resource. "defaultTtl": "A String", # Optional. The default TTL duration of the memories in the Memory Bank. This applies to all operations that create or update a memory. "granularTtlConfig": { # Configuration for TTL of the memories in the Memory Bank based on the action that created or updated the memory. # Optional. The granular TTL configuration of the memories in the Memory Bank. @@ -338,6 +408,14 @@

Method Details

"imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. + "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. + "agentToAnywhereConfig": { # Configuration for traffic originating from a Reasoning Engine. # Optional. Configuration for traffic originating from the Reasoning Engine. When unset, outgoing traffic is not routed through an Agent Gateway. + "agentGateway": "A String", # Required. The resource name of the Agent Gateway for outbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `AGENT_TO_ANYWHERE`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}` + }, + "clientToAgentConfig": { # Configuration for traffic targeting a Reasoning Engine. # Optional. Configuration for traffic targeting the Reasoning Engine. When unset, incoming traffic is not routed through an Agent Gateway. + "agentGateway": "A String", # Required. The resource name of the Agent Gateway to use for inbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `CLIENT_TO_AGENT`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}` + }, + }, "agentServerMode": "A String", # The agent server mode. "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9. "env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API. @@ -421,6 +499,18 @@

Method Details

}, }, }, + "trafficConfig": { # Traffic distribution configuration. # Optional. Traffic distribution configuration for the Reasoning Engine. + "trafficSplitAlwaysLatest": { # Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision. # Optional. Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision. + }, + "trafficSplitManual": { # Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each. # Optional. Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each. + "targets": [ # A list of traffic targets for the Runtimes Revisions. The sum of percentages must equal to 100. + { # A single target for the traffic split, specifying a Runtime Revision and the percentage of traffic to send to it. + "percent": 42, # Required. Specifies percent of the traffic to this Runtime Revision. + "runtimeRevisionName": "A String", # Required. The Runtime Revision name to which to send this portion of traffic, if traffic allocation is by Runtime Revision. + }, + ], + }, + }, "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated. } @@ -553,17 +643,18 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Represents configuration for organizing memories for a particular scope. + { # Represents configuration for organizing natural language memories for a particular scope. "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. - "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + "revisionsPerCandidateCount": 42, # Optional. Represents the maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. }, - "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") - "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. + "disableNaturalLanguageMemories": True or False, # Optional. Indicates whether natural language memory generation should be disabled for all requests. By default, natural language memory generation is enabled. Set this to `true` when you only want to generate structured memories. + "enableThirdPersonMemories": True or False, # Optional. Indicates whether the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") + "generateMemoriesExamples": [ # Optional. Provides examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. "conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. - "events": [ # Optional. The input conversation events for the example. + "events": [ # Optional. Represents the input conversation events for the example. { # A single conversation event. - "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. + "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. Represents the content of the event. "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. @@ -642,42 +733,101 @@

Method Details

}, ], }, - "generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. + "generatedMemories": [ # Optional. Represents the memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. - "fact": "A String", # Required. The fact to generate a memory from. - "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + "fact": "A String", # Required. Represents the fact to generate a memory from. + "topics": [ # Optional. Represents the list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], }, ], }, ], - "memoryTopics": [ # Optional. Topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. + "memoryTopics": [ # Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. { # A topic of information that should be extracted from conversations and stored as memories. "customMemoryTopic": { # A custom memory topic defined by the developer. # A custom memory topic defined by the developer. - "description": "A String", # Required. Description of the memory topic. This should explain what information should be extracted for this topic. - "label": "A String", # Required. The label of the topic. + "description": "A String", # Required. Represents the description of the memory topic. This should explain what information should be extracted for this topic. + "label": "A String", # Required. Represents the label of the topic. }, "managedMemoryTopic": { # A managed memory topic defined by the system. # A managed memory topic defined by Memory Bank. - "managedTopicEnum": "A String", # Required. The managed topic. + "managedTopicEnum": "A String", # Required. Represents the managed topic. }, }, ], - "scopeKeys": [ # Optional. The scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. "A String", ], }, ], "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. - "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. + "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Specifies the default trigger configuration for generating memories using `IngestEvents`. + "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately. + "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. + "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. + "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + }, + }, + "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, "similaritySearchConfig": { # Configuration for how to perform similarity search on memories. # Optional. Configuration for how to perform similarity search on memories. If not set, the Memory Bank will use the default embedding model `text-embedding-005`. "embeddingModel": "A String", # Required. The model used to generate embeddings to lookup similar memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, + "structuredMemoryConfigs": [ # Optional. Configuration for organizing structured memories for a particular scope. + { # Represents configuration for organizing structured memories for a particular scope. + "schemaConfigs": [ # Optional. Represents configuration of the structured memories' schemas. + { # Schema configuration for structured memories. + "id": "A String", # Required. Represents the ID of the schema. Must be 1-63 characters, start with a lowercase letter, and consist of lowercase letters, numbers, and hyphens. + "memoryType": "A String", # Optional. Represents the type of the structured memories associated with the schema. If not set, then `STRUCTURED_PROFILE` will be used. + "schema": { # 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). # Required. Represents the OpenAPI schema of the structured memories. The schema `type` cannot be `ARRAY` when `memory_type` is `STRUCTURED_PROFILE`. + "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. + }, + }, + ], + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "A String", + ], + }, + ], "ttlConfig": { # Configuration for automatically setting the TTL ("time-to-live") of the memories in the Memory Bank. # Optional. Configuration for automatic TTL ("time-to-live") of the memories in the Memory Bank. If not set, TTL will not be applied automatically. The TTL can be explicitly set by modifying the `expire_time` of each Memory resource. "defaultTtl": "A String", # Optional. The default TTL duration of the memories in the Memory Bank. This applies to all operations that create or update a memory. "granularTtlConfig": { # Configuration for TTL of the memories in the Memory Bank based on the action that created or updated the memory. # Optional. The granular TTL configuration of the memories in the Memory Bank. @@ -714,6 +864,14 @@

Method Details

"imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. + "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. + "agentToAnywhereConfig": { # Configuration for traffic originating from a Reasoning Engine. # Optional. Configuration for traffic originating from the Reasoning Engine. When unset, outgoing traffic is not routed through an Agent Gateway. + "agentGateway": "A String", # Required. The resource name of the Agent Gateway for outbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `AGENT_TO_ANYWHERE`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}` + }, + "clientToAgentConfig": { # Configuration for traffic targeting a Reasoning Engine. # Optional. Configuration for traffic targeting the Reasoning Engine. When unset, incoming traffic is not routed through an Agent Gateway. + "agentGateway": "A String", # Required. The resource name of the Agent Gateway to use for inbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `CLIENT_TO_AGENT`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}` + }, + }, "agentServerMode": "A String", # The agent server mode. "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9. "env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API. @@ -797,6 +955,18 @@

Method Details

}, }, }, + "trafficConfig": { # Traffic distribution configuration. # Optional. Traffic distribution configuration for the Reasoning Engine. + "trafficSplitAlwaysLatest": { # Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision. # Optional. Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision. + }, + "trafficSplitManual": { # Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each. # Optional. Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each. + "targets": [ # A list of traffic targets for the Runtimes Revisions. The sum of percentages must equal to 100. + { # A single target for the traffic split, specifying a Runtime Revision and the percentage of traffic to send to it. + "percent": 42, # Required. Specifies percent of the traffic to this Runtime Revision. + "runtimeRevisionName": "A String", # Required. The Runtime Revision name to which to send this portion of traffic, if traffic allocation is by Runtime Revision. + }, + ], + }, + }, "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated. } @@ -860,17 +1030,18 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Represents configuration for organizing memories for a particular scope. + { # Represents configuration for organizing natural language memories for a particular scope. "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. - "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + "revisionsPerCandidateCount": 42, # Optional. Represents the maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. }, - "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") - "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. + "disableNaturalLanguageMemories": True or False, # Optional. Indicates whether natural language memory generation should be disabled for all requests. By default, natural language memory generation is enabled. Set this to `true` when you only want to generate structured memories. + "enableThirdPersonMemories": True or False, # Optional. Indicates whether the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") + "generateMemoriesExamples": [ # Optional. Provides examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. "conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. - "events": [ # Optional. The input conversation events for the example. + "events": [ # Optional. Represents the input conversation events for the example. { # A single conversation event. - "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. + "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. Represents the content of the event. "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. @@ -949,42 +1120,101 @@

Method Details

}, ], }, - "generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. + "generatedMemories": [ # Optional. Represents the memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. - "fact": "A String", # Required. The fact to generate a memory from. - "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + "fact": "A String", # Required. Represents the fact to generate a memory from. + "topics": [ # Optional. Represents the list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], }, ], }, ], - "memoryTopics": [ # Optional. Topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. + "memoryTopics": [ # Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. { # A topic of information that should be extracted from conversations and stored as memories. "customMemoryTopic": { # A custom memory topic defined by the developer. # A custom memory topic defined by the developer. - "description": "A String", # Required. Description of the memory topic. This should explain what information should be extracted for this topic. - "label": "A String", # Required. The label of the topic. + "description": "A String", # Required. Represents the description of the memory topic. This should explain what information should be extracted for this topic. + "label": "A String", # Required. Represents the label of the topic. }, "managedMemoryTopic": { # A managed memory topic defined by the system. # A managed memory topic defined by Memory Bank. - "managedTopicEnum": "A String", # Required. The managed topic. + "managedTopicEnum": "A String", # Required. Represents the managed topic. }, }, ], - "scopeKeys": [ # Optional. The scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. "A String", ], }, ], "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. - "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. + "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Specifies the default trigger configuration for generating memories using `IngestEvents`. + "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately. + "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. + "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. + "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + }, + }, + "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, "similaritySearchConfig": { # Configuration for how to perform similarity search on memories. # Optional. Configuration for how to perform similarity search on memories. If not set, the Memory Bank will use the default embedding model `text-embedding-005`. "embeddingModel": "A String", # Required. The model used to generate embeddings to lookup similar memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, + "structuredMemoryConfigs": [ # Optional. Configuration for organizing structured memories for a particular scope. + { # Represents configuration for organizing structured memories for a particular scope. + "schemaConfigs": [ # Optional. Represents configuration of the structured memories' schemas. + { # Schema configuration for structured memories. + "id": "A String", # Required. Represents the ID of the schema. Must be 1-63 characters, start with a lowercase letter, and consist of lowercase letters, numbers, and hyphens. + "memoryType": "A String", # Optional. Represents the type of the structured memories associated with the schema. If not set, then `STRUCTURED_PROFILE` will be used. + "schema": { # 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). # Required. Represents the OpenAPI schema of the structured memories. The schema `type` cannot be `ARRAY` when `memory_type` is `STRUCTURED_PROFILE`. + "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. + }, + }, + ], + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "A String", + ], + }, + ], "ttlConfig": { # Configuration for automatically setting the TTL ("time-to-live") of the memories in the Memory Bank. # Optional. Configuration for automatic TTL ("time-to-live") of the memories in the Memory Bank. If not set, TTL will not be applied automatically. The TTL can be explicitly set by modifying the `expire_time` of each Memory resource. "defaultTtl": "A String", # Optional. The default TTL duration of the memories in the Memory Bank. This applies to all operations that create or update a memory. "granularTtlConfig": { # Configuration for TTL of the memories in the Memory Bank based on the action that created or updated the memory. # Optional. The granular TTL configuration of the memories in the Memory Bank. @@ -1021,6 +1251,14 @@

Method Details

"imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. + "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. + "agentToAnywhereConfig": { # Configuration for traffic originating from a Reasoning Engine. # Optional. Configuration for traffic originating from the Reasoning Engine. When unset, outgoing traffic is not routed through an Agent Gateway. + "agentGateway": "A String", # Required. The resource name of the Agent Gateway for outbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `AGENT_TO_ANYWHERE`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}` + }, + "clientToAgentConfig": { # Configuration for traffic targeting a Reasoning Engine. # Optional. Configuration for traffic targeting the Reasoning Engine. When unset, incoming traffic is not routed through an Agent Gateway. + "agentGateway": "A String", # Required. The resource name of the Agent Gateway to use for inbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `CLIENT_TO_AGENT`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}` + }, + }, "agentServerMode": "A String", # The agent server mode. "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9. "env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API. @@ -1104,6 +1342,18 @@

Method Details

}, }, }, + "trafficConfig": { # Traffic distribution configuration. # Optional. Traffic distribution configuration for the Reasoning Engine. + "trafficSplitAlwaysLatest": { # Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision. # Optional. Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision. + }, + "trafficSplitManual": { # Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each. # Optional. Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each. + "targets": [ # A list of traffic targets for the Runtimes Revisions. The sum of percentages must equal to 100. + { # A single target for the traffic split, specifying a Runtime Revision and the percentage of traffic to send to it. + "percent": 42, # Required. Specifies percent of the traffic to this Runtime Revision. + "runtimeRevisionName": "A String", # Required. The Runtime Revision name to which to send this portion of traffic, if traffic allocation is by Runtime Revision. + }, + ], + }, + }, "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated. }, ], @@ -1137,17 +1387,18 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Represents configuration for organizing memories for a particular scope. + { # Represents configuration for organizing natural language memories for a particular scope. "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. - "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + "revisionsPerCandidateCount": 42, # Optional. Represents the maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. }, - "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") - "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. + "disableNaturalLanguageMemories": True or False, # Optional. Indicates whether natural language memory generation should be disabled for all requests. By default, natural language memory generation is enabled. Set this to `true` when you only want to generate structured memories. + "enableThirdPersonMemories": True or False, # Optional. Indicates whether the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") + "generateMemoriesExamples": [ # Optional. Provides examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. "conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. - "events": [ # Optional. The input conversation events for the example. + "events": [ # Optional. Represents the input conversation events for the example. { # A single conversation event. - "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. + "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. Represents the content of the event. "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. @@ -1226,42 +1477,101 @@

Method Details

}, ], }, - "generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. + "generatedMemories": [ # Optional. Represents the memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. - "fact": "A String", # Required. The fact to generate a memory from. - "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + "fact": "A String", # Required. Represents the fact to generate a memory from. + "topics": [ # Optional. Represents the list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], }, ], }, ], - "memoryTopics": [ # Optional. Topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. + "memoryTopics": [ # Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. { # A topic of information that should be extracted from conversations and stored as memories. "customMemoryTopic": { # A custom memory topic defined by the developer. # A custom memory topic defined by the developer. - "description": "A String", # Required. Description of the memory topic. This should explain what information should be extracted for this topic. - "label": "A String", # Required. The label of the topic. + "description": "A String", # Required. Represents the description of the memory topic. This should explain what information should be extracted for this topic. + "label": "A String", # Required. Represents the label of the topic. }, "managedMemoryTopic": { # A managed memory topic defined by the system. # A managed memory topic defined by Memory Bank. - "managedTopicEnum": "A String", # Required. The managed topic. + "managedTopicEnum": "A String", # Required. Represents the managed topic. }, }, ], - "scopeKeys": [ # Optional. The scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. "A String", ], }, ], "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. - "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. + "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Specifies the default trigger configuration for generating memories using `IngestEvents`. + "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately. + "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. + "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. + "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + }, + }, + "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, "similaritySearchConfig": { # Configuration for how to perform similarity search on memories. # Optional. Configuration for how to perform similarity search on memories. If not set, the Memory Bank will use the default embedding model `text-embedding-005`. "embeddingModel": "A String", # Required. The model used to generate embeddings to lookup similar memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, + "structuredMemoryConfigs": [ # Optional. Configuration for organizing structured memories for a particular scope. + { # Represents configuration for organizing structured memories for a particular scope. + "schemaConfigs": [ # Optional. Represents configuration of the structured memories' schemas. + { # Schema configuration for structured memories. + "id": "A String", # Required. Represents the ID of the schema. Must be 1-63 characters, start with a lowercase letter, and consist of lowercase letters, numbers, and hyphens. + "memoryType": "A String", # Optional. Represents the type of the structured memories associated with the schema. If not set, then `STRUCTURED_PROFILE` will be used. + "schema": { # 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). # Required. Represents the OpenAPI schema of the structured memories. The schema `type` cannot be `ARRAY` when `memory_type` is `STRUCTURED_PROFILE`. + "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. + }, + }, + ], + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "A String", + ], + }, + ], "ttlConfig": { # Configuration for automatically setting the TTL ("time-to-live") of the memories in the Memory Bank. # Optional. Configuration for automatic TTL ("time-to-live") of the memories in the Memory Bank. If not set, TTL will not be applied automatically. The TTL can be explicitly set by modifying the `expire_time` of each Memory resource. "defaultTtl": "A String", # Optional. The default TTL duration of the memories in the Memory Bank. This applies to all operations that create or update a memory. "granularTtlConfig": { # Configuration for TTL of the memories in the Memory Bank based on the action that created or updated the memory. # Optional. The granular TTL configuration of the memories in the Memory Bank. @@ -1298,6 +1608,14 @@

Method Details

"imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. + "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. + "agentToAnywhereConfig": { # Configuration for traffic originating from a Reasoning Engine. # Optional. Configuration for traffic originating from the Reasoning Engine. When unset, outgoing traffic is not routed through an Agent Gateway. + "agentGateway": "A String", # Required. The resource name of the Agent Gateway for outbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `AGENT_TO_ANYWHERE`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}` + }, + "clientToAgentConfig": { # Configuration for traffic targeting a Reasoning Engine. # Optional. Configuration for traffic targeting the Reasoning Engine. When unset, incoming traffic is not routed through an Agent Gateway. + "agentGateway": "A String", # Required. The resource name of the Agent Gateway to use for inbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `CLIENT_TO_AGENT`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}` + }, + }, "agentServerMode": "A String", # The agent server mode. "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9. "env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API. @@ -1381,6 +1699,18 @@

Method Details

}, }, }, + "trafficConfig": { # Traffic distribution configuration. # Optional. Traffic distribution configuration for the Reasoning Engine. + "trafficSplitAlwaysLatest": { # Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision. # Optional. Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision. + }, + "trafficSplitManual": { # Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each. # Optional. Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each. + "targets": [ # A list of traffic targets for the Runtimes Revisions. The sum of percentages must equal to 100. + { # A single target for the traffic split, specifying a Runtime Revision and the percentage of traffic to send to it. + "percent": 42, # Required. Specifies percent of the traffic to this Runtime Revision. + "runtimeRevisionName": "A String", # Required. The Runtime Revision name to which to send this portion of traffic, if traffic allocation is by Runtime Revision. + }, + ], + }, + }, "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated. } diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html index 8a6a1907c1..8748b43c57 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html @@ -99,6 +99,9 @@

Instance Methods

get(name, x__xgafv=None)

Get a Memory.

+

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

+

Ingests events for a Memory Bank.

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

List Memories.

@@ -114,6 +117,9 @@

Instance Methods

retrieve(parent, body=None, x__xgafv=None)

Retrieve memories.

+

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

+

Retrieves profiles.

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

Rollback Memory to a specific revision.

@@ -133,37 +139,44 @@

Method Details

The object takes the form of: { # A memory. - "createTime": "A String", # Output only. Timestamp when this Memory was created. - "description": "A String", # Optional. Description of the Memory. - "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", # 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. + "createTime": "A String", # Output only. Represents the timestamp when this Memory was created. + "description": "A String", # Optional. Represents the description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request. + "displayName": "A String", # Optional. Represents the display name of the Memory. + "expireTime": "A String", # Optional. Represents the 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", # Optional. Represents semantic knowledge extracted from the source content. + "memoryType": "A String", # Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided. + "metadata": { # Optional. Represents 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. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, - "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` - "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. - "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request. "a_key": "A String", }, - "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. - "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. + "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL. + "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, - "topics": [ # Optional. The Topics of the Memory. + "structuredContent": { # Represents the structured value of the memory. # Optional. Represents the structured content of the memory. + "data": { # Required. Represents the structured value of the memory. + "a_key": "", # Properties of the object. + }, + "schemaId": "A String", # Required. Represents the schema ID for which this structured memory belongs to. + }, + "topics": [ # Optional. Represents the Topics of the Memory. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], - "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. - "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. + "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL. + "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated. } memoryId: string, Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number. @@ -241,6 +254,12 @@

Method Details

The object takes the form of: { # Request message for MemoryBankService.GenerateMemories. Maximum size is 8 MB. + "allowedTopics": [ # Optional. Restricts memory generation to a subset of memory topics. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. + }, + ], "directContentsSource": { # Defines a direct source of content from which to generate the memories. # Defines a direct source of content as the source content from which to generate memories. "events": [ # Required. The source content (i.e. chat history) to generate memories from. { # A single piece of conversation from which to generate memories. @@ -329,8 +348,8 @@

Method Details

"fact": "A String", # Required. The fact to consolidate with existing memories. "topics": [ # Optional. The topics that the consolidated memories should be associated with. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], }, @@ -340,10 +359,10 @@

Method Details

"disableMemoryRevisions": True or False, # Optional. If true, no revisions will be created for this request. "metadata": { # Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank. "a_key": { # Memory metadata. - "boolValue": True or False, # Boolean value. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, "metadataMergeStrategy": "A String", # Optional. The strategy to use when applying metadata to existing memories. @@ -406,37 +425,181 @@

Method Details

An object of the form: { # A memory. - "createTime": "A String", # Output only. Timestamp when this Memory was created. - "description": "A String", # Optional. Description of the Memory. - "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", # 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. + "createTime": "A String", # Output only. Represents the timestamp when this Memory was created. + "description": "A String", # Optional. Represents the description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request. + "displayName": "A String", # Optional. Represents the display name of the Memory. + "expireTime": "A String", # Optional. Represents the 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", # Optional. Represents semantic knowledge extracted from the source content. + "memoryType": "A String", # Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided. + "metadata": { # Optional. Represents 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. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, - "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` - "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. - "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request. "a_key": "A String", }, - "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. - "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. + "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL. + "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, - "topics": [ # Optional. The Topics of the Memory. + "structuredContent": { # Represents the structured value of the memory. # Optional. Represents the structured content of the memory. + "data": { # Required. Represents the structured value of the memory. + "a_key": "", # Properties of the object. + }, + "schemaId": "A String", # Required. Represents the schema ID for which this structured memory belongs to. + }, + "topics": [ # Optional. Represents the Topics of the Memory. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], - "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. - "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. + "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL. + "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated. +} + + +
+ ingestEvents(parent, body=None, x__xgafv=None) +
Ingests events for a Memory Bank.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.IngestEvents.
+  "directContentsSource": { # Ingest events directly from the request. # Ingest events directly from the request.
+    "events": [ # Required. The events to ingest.
+      { # A single event to ingest.
+        "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.
+          "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'.
+        },
+        "eventId": "A String", # Optional. A unique identifier for the event. If an event with the same event_id is ingested multiple times, it will be de-duplicated.
+        "eventTime": "A String", # Optional. The time at which the event occurred. If provided, this timestamp will be used for ordering events within a stream. If not provided, the server-side ingestion time will be used.
+      },
+    ],
+  },
+  "forceFlush": True or False, # Optional. Forces a flush of all pending events in the stream and triggers memory generation immediately bypassing any conditions configured in the `generation_trigger_config`.
+  "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Configuration for triggering memory generation from this ingestion. If not set, then the stream will be force flushed immediately.
+    "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately.
+      "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit.
+      "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity.
+      "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity.
+    },
+  },
+  "scope": { # Required. The scope of the memories that should be generated from the stream. Memories will be consolidated across memories with the same scope. Scope values cannot contain the wildcard character '*'.
+    "a_key": "A String",
+  },
+  "streamId": "A String", # Optional. The ID of the stream to ingest events into. If not provided, a new one will be created.
+}
+
+  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.
+  },
 }
@@ -461,37 +624,44 @@

Method Details

{ # Response message for MemoryBankService.ListMemories. "memories": [ # List of Memories in the requested page. { # A memory. - "createTime": "A String", # Output only. Timestamp when this Memory was created. - "description": "A String", # Optional. Description of the Memory. - "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", # 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. + "createTime": "A String", # Output only. Represents the timestamp when this Memory was created. + "description": "A String", # Optional. Represents the description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request. + "displayName": "A String", # Optional. Represents the display name of the Memory. + "expireTime": "A String", # Optional. Represents the 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", # Optional. Represents semantic knowledge extracted from the source content. + "memoryType": "A String", # Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided. + "metadata": { # Optional. Represents 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. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, - "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` - "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. - "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request. "a_key": "A String", }, - "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. - "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. + "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL. + "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, - "topics": [ # Optional. The Topics of the Memory. + "structuredContent": { # Represents the structured value of the memory. # Optional. Represents the structured content of the memory. + "data": { # Required. Represents the structured value of the memory. + "a_key": "", # Properties of the object. + }, + "schemaId": "A String", # Required. Represents the schema ID for which this structured memory belongs to. + }, + "topics": [ # Optional. Represents the Topics of the Memory. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], - "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. - "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. + "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL. + "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated. }, ], "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListMemoriesRequest.page_token to obtain that page. @@ -517,42 +687,49 @@

Method Details

Update a Memory.
 
 Args:
-  name: string, Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  name: string, Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
   body: object, The request body.
     The object takes the form of:
 
 { # A memory.
-  "createTime": "A String", # Output only. Timestamp when this Memory was created.
-  "description": "A String", # Optional. Description of the Memory.
-  "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", # 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.
+  "createTime": "A String", # Output only. Represents the timestamp when this Memory was created.
+  "description": "A String", # Optional. Represents the description of the Memory.
+  "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request.
+  "displayName": "A String", # Optional. Represents the display name of the Memory.
+  "expireTime": "A String", # Optional. Represents the 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", # Optional. Represents semantic knowledge extracted from the source content.
+  "memoryType": "A String", # Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided.
+  "metadata": { # Optional. Represents 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.
-      "doubleValue": 3.14, # Double value.
-      "stringValue": "A String", # String value.
-      "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+      "boolValue": True or False, # Represents a boolean value.
+      "doubleValue": 3.14, # Represents a double value.
+      "stringValue": "A String", # Represents a string value.
+      "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
     },
   },
-  "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
-  "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
-  "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request.
+  "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
+  "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+  "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
     "a_key": "A String",
   },
-  "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL.
-  "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
+  "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
+  "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
     "a_key": "A String",
   },
-  "topics": [ # Optional. The Topics of the Memory.
+  "structuredContent": { # Represents the structured value of the memory. # Optional. Represents the structured content of the memory.
+    "data": { # Required. Represents the structured value of the memory.
+      "a_key": "", # Properties of the object.
+    },
+    "schemaId": "A String", # Required. Represents the schema ID for which this structured memory belongs to.
+  },
+  "topics": [ # Optional. Represents the Topics of the Memory.
     { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
-      "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label.
-      "managedMemoryTopic": "A String", # Optional. The managed memory topic.
+      "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+      "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
     },
   ],
-  "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.
-  "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated.
+  "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated.
 }
 
   updateMask: string, Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`
@@ -598,16 +775,16 @@ 

Method Details

"filter": "A String", # Required. The standard list filter to determine which memories to purge. More detail in [AIP-160](https://google.aip.dev/160). "filterGroups": [ # Optional. Metadata filters that will be applied to the memories to be purged. Filters are defined using disjunctive normal form (OR of ANDs). For example: `filter_groups: [{filters: [{key: "author", value: {string_value: "agent 123"}, op: EQUAL}]}, {filters: [{key: "label", value: {string_value: "travel"}, op: EQUAL}, {key: "author", value: {string_value: "agent 321"}, op: EQUAL}]}]` would be equivalent to the logical expression: `(metadata.author = "agent 123" OR (metadata.label = "travel" AND metadata.author = "agent 321"))`. { # A conjunction of filters that will be combined using AND logic. - "filters": [ # Filters that will combined using AND logic. + "filters": [ # Represents filters that will be combined using AND logic. { # Filter to apply when retrieving memories. - "key": "A String", # Key of the filter. For example, "author" would apply to `metadata` entries with the key "author". - "negate": True or False, # If true, the filter will be negated. - "op": "A String", # Operator to apply to the filter. If not set, then EQUAL will be used. - "value": { # Memory metadata. # Value to compare to. - "boolValue": True or False, # Boolean value. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "key": "A String", # Represents the key of the filter. For example, "author" would apply to `metadata` entries with the key "author". + "negate": True or False, # Indicates whether the filter will be negated. + "op": "A String", # Represents the operator to apply to the filter. If not set, then EQUAL will be used. + "value": { # Memory metadata. # Represents the value to compare to. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, ], @@ -658,21 +835,24 @@

Method Details

"filter": "A String", # Optional. The standard list filter that will be applied to the retrieved memories. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `fact` * `create_time` * `update_time` * `topics` (i.e. `topics.custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES`) "filterGroups": [ # Optional. Metadata filters that will be applied to the retrieved memories' `metadata` using OR logic. Filters are defined using disjunctive normal form (OR of ANDs). For example: `filter_groups: [{filters: [{key: "author", value: {string_value: "agent 123"}, op: EQUAL}]}, {filters: [{key: "label", value: {string_value: "travel"}, op: EQUAL}, {key: "author", value: {string_value: "agent 321"}, op: EQUAL}]}]` would be equivalent to the logical expression: `(metadata.author = "agent 123" OR (metadata.label = "travel" AND metadata.author = "agent 321"))`. { # A conjunction of filters that will be combined using AND logic. - "filters": [ # Filters that will combined using AND logic. + "filters": [ # Represents filters that will be combined using AND logic. { # Filter to apply when retrieving memories. - "key": "A String", # Key of the filter. For example, "author" would apply to `metadata` entries with the key "author". - "negate": True or False, # If true, the filter will be negated. - "op": "A String", # Operator to apply to the filter. If not set, then EQUAL will be used. - "value": { # Memory metadata. # Value to compare to. - "boolValue": True or False, # Boolean value. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "key": "A String", # Represents the key of the filter. For example, "author" would apply to `metadata` entries with the key "author". + "negate": True or False, # Indicates whether the filter will be negated. + "op": "A String", # Represents the operator to apply to the filter. If not set, then EQUAL will be used. + "value": { # Memory metadata. # Represents the value to compare to. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, ], }, ], + "memoryTypes": [ # Optional. Specifies the types of memories to retrieve. If this field is empty or not provided, the request will default to retrieving only memories of type `NATURAL_LANGUAGE_COLLECTION`. If populated, the request will retrieve memories matching any of the specified `MemoryType` values. + "A String", + ], "scope": { # Required. The scope of the memories to retrieve. A memory must have exactly the same scope (`Memory.scope`) as the scope provided here to be retrieved (same keys and values). Order does not matter, but it is case-sensitive. "a_key": "A String", }, @@ -700,43 +880,85 @@

Method Details

{ # A retrieved memory. "distance": 3.14, # The distance between the query and the retrieved Memory. Smaller values indicate more similar memories. This is only set if similarity search was used for retrieval. "memory": { # A memory. # The retrieved Memory. - "createTime": "A String", # Output only. Timestamp when this Memory was created. - "description": "A String", # Optional. Description of the Memory. - "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", # 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. + "createTime": "A String", # Output only. Represents the timestamp when this Memory was created. + "description": "A String", # Optional. Represents the description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request. + "displayName": "A String", # Optional. Represents the display name of the Memory. + "expireTime": "A String", # Optional. Represents the 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", # Optional. Represents semantic knowledge extracted from the source content. + "memoryType": "A String", # Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided. + "metadata": { # Optional. Represents 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. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, - "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` - "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. - "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request. "a_key": "A String", }, - "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. - "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. + "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL. + "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, - "topics": [ # Optional. The Topics of the Memory. + "structuredContent": { # Represents the structured value of the memory. # Optional. Represents the structured content of the memory. + "data": { # Required. Represents the structured value of the memory. + "a_key": "", # Properties of the object. + }, + "schemaId": "A String", # Required. Represents the schema ID for which this structured memory belongs to. + }, + "topics": [ # Optional. Represents the Topics of the Memory. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], - "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. - "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. + "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL. + "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated. }, }, ], }
+
+ retrieveProfiles(parent, body=None, x__xgafv=None) +
Retrieves profiles.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to retrieve profiles from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.RetrieveProfiles.
+  "scope": { # Required. The scope of the profiles to retrieve.
+    "a_key": "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 MemoryBankService.RetrieveProfiles.
+  "profiles": { # The retrieved structured profiles, which match the schemas under the requested scope. The key is the ID of the schema that the profile is linked with, which corresponds to the `schema_id` defined inside the `SchemaConfig`, under `StructuredMemoryCustomizationConfig`.
+    "a_key": { # A memory profile.
+      "profile": { # Represents the profile data.
+        "a_key": "", # Properties of the object.
+      },
+      "schemaId": "A String", # Represents the ID of the schema. This ID corresponds to the `schema_id` defined inside the SchemaConfig, under StructuredMemoryCustomizationConfig.
+    },
+  },
+}
+
+
rollback(name, body=None, x__xgafv=None)
Rollback Memory to a specific revision.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.revisions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.revisions.html
index 9cf200f7aa..c39afaefe4 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.revisions.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.revisions.html
@@ -107,18 +107,25 @@ 

Method Details

An object of the form: { # A revision of a Memory. - "createTime": "A String", # Output only. Timestamp when this Memory Revision was created. - "expireTime": "A String", # Output only. Timestamp of when this resource is considered expired. - "extractedMemories": [ # Output only. The extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation. + "createTime": "A String", # Output only. Represents the timestamp when this Memory Revision was created. + "expireTime": "A String", # Output only. Represents the timestamp of when this resource is considered expired. + "extractedMemories": [ # Output only. Represents the extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation. { # An extracted memory that is the intermediate result before consolidation. - "fact": "A String", # Output only. The fact of the extracted memory. + "context": "A String", # Output only. Represents the explanation of why the information was extracted from the source content. + "fact": "A String", # Output only. Represents the fact of the extracted memory. + "structuredData": { # Output only. Represents the structured value of the extracted memory. + "a_key": "", # Properties of the object. + }, }, ], - "fact": "A String", # Output only. The fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation. - "labels": { # Output only. The labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`. + "fact": "A String", # Output only. Represents the fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation. + "labels": { # Output only. Represents the labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`. "a_key": "A String", }, - "name": "A String", # Identifier. The resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}` + "name": "A String", # Identifier. Represents the resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}` + "structuredData": { # Output only. Represents the structured value of the memory at the time of revision creation. + "a_key": "", # Properties of the object. + }, }
@@ -142,18 +149,25 @@

Method Details

{ # Response message for MemoryBankService.ListMemoryRevisions. "memoryRevisions": [ # The list of Memory Revisions in the request page. { # A revision of a Memory. - "createTime": "A String", # Output only. Timestamp when this Memory Revision was created. - "expireTime": "A String", # Output only. Timestamp of when this resource is considered expired. - "extractedMemories": [ # Output only. The extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation. + "createTime": "A String", # Output only. Represents the timestamp when this Memory Revision was created. + "expireTime": "A String", # Output only. Represents the timestamp of when this resource is considered expired. + "extractedMemories": [ # Output only. Represents the extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation. { # An extracted memory that is the intermediate result before consolidation. - "fact": "A String", # Output only. The fact of the extracted memory. + "context": "A String", # Output only. Represents the explanation of why the information was extracted from the source content. + "fact": "A String", # Output only. Represents the fact of the extracted memory. + "structuredData": { # Output only. Represents the structured value of the extracted memory. + "a_key": "", # Properties of the object. + }, }, ], - "fact": "A String", # Output only. The fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation. - "labels": { # Output only. The labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`. + "fact": "A String", # Output only. Represents the fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation. + "labels": { # Output only. Represents the labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`. "a_key": "A String", }, - "name": "A String", # Identifier. The resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}` + "name": "A String", # Identifier. Represents the resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}` + "structuredData": { # Output only. Represents the structured value of the memory at the time of revision creation. + "a_key": "", # Properties of the object. + }, }, ], "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. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.html new file mode 100644 index 0000000000..493ed81c42 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.html @@ -0,0 +1,149 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . runtimeRevisions . a2a

+

Instance Methods

+

+ message() +

+

Returns the message Resource.

+ +

+ tasks() +

+

Returns the tasks Resource.

+ +

+ v1() +

+

Returns the v1 Resource.

+ +

+ card(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

+ close()

+

Close httplib2 connections.

+

+ extendedAgentCard(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

Method Details

+
+ card(name, a2aEndpoint, historyLength=None, x__xgafv=None) +
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ extendedAgentCard(name, a2aEndpoint, historyLength=None, x__xgafv=None) +
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.message.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.message.html new file mode 100644 index 0000000000..9da736a30c --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.message.html @@ -0,0 +1,140 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . runtimeRevisions . a2a . message

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ send(name, a2aEndpoint, body=None, x__xgafv=None)

+

Send post request for reasoning engine instance via the A2A post protocol apis.

+

+ stream(name, a2aEndpoint, body=None, x__xgafv=None)

+

Streams queries using a reasoning engine instance via the A2A streaming protocol apis.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ send(name, a2aEndpoint, body=None, x__xgafv=None) +
Send post request for reasoning engine instance via the A2A post protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send (required)
+  body: object, The request body.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ stream(name, a2aEndpoint, body=None, x__xgafv=None) +
Streams queries using a reasoning engine instance via the A2A streaming protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. e.g., v1/message:stream. (required)
+  body: object, The request body.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "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.reasoningEngines.runtimeRevisions.a2a.tasks.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.html new file mode 100644 index 0000000000..b26dc61daf --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.html @@ -0,0 +1,168 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . runtimeRevisions . a2a . tasks

+

Instance Methods

+

+ pushNotificationConfigs() +

+

Returns the pushNotificationConfigs Resource.

+ +

+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

+ cancel(name, a2aEndpoint, body=None, x__xgafv=None)

+

Send post request for reasoning engine instance via the A2A post protocol apis.

+

+ close()

+

Close httplib2 connections.

+

+ subscribe(name, a2aEndpoint, x__xgafv=None)

+

Stream get request for reasoning engine instance via the A2A stream get protocol apis.

+

Method Details

+
+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None) +
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ cancel(name, a2aEndpoint, body=None, x__xgafv=None) +
Send post request for reasoning engine instance via the A2A post protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send (required)
+  body: object, The request body.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ subscribe(name, a2aEndpoint, x__xgafv=None) +
Stream get request for reasoning engine instance via the A2A stream get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "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.reasoningEngines.runtimeRevisions.a2a.tasks.pushNotificationConfigs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.pushNotificationConfigs.html new file mode 100644 index 0000000000..139bb8473f --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.pushNotificationConfigs.html @@ -0,0 +1,110 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . runtimeRevisions . a2a . tasks . pushNotificationConfigs

+

Instance Methods

+

+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None) +
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.html new file mode 100644 index 0000000000..f41b5794cf --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.html @@ -0,0 +1,144 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . runtimeRevisions . a2a . v1

+

Instance Methods

+

+ message() +

+

Returns the message Resource.

+ +

+ tasks() +

+

Returns the tasks Resource.

+ +

+ card(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

+ close()

+

Close httplib2 connections.

+

+ extendedAgentCard(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

Method Details

+
+ card(name, a2aEndpoint, historyLength=None, x__xgafv=None) +
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ extendedAgentCard(name, a2aEndpoint, historyLength=None, x__xgafv=None) +
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.message.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.message.html new file mode 100644 index 0000000000..77e66bbfb8 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.message.html @@ -0,0 +1,140 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . runtimeRevisions . a2a . v1 . message

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ send(name, a2aEndpoint, body=None, x__xgafv=None)

+

Send post request for reasoning engine instance via the A2A post protocol apis.

+

+ stream(name, a2aEndpoint, body=None, x__xgafv=None)

+

Streams queries using a reasoning engine instance via the A2A streaming protocol apis.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ send(name, a2aEndpoint, body=None, x__xgafv=None) +
Send post request for reasoning engine instance via the A2A post protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send (required)
+  body: object, The request body.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ stream(name, a2aEndpoint, body=None, x__xgafv=None) +
Streams queries using a reasoning engine instance via the A2A streaming protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. e.g., v1/message:stream. (required)
+  body: object, The request body.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "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.reasoningEngines.runtimeRevisions.a2a.v1.tasks.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.html new file mode 100644 index 0000000000..f8e9548623 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.html @@ -0,0 +1,168 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . runtimeRevisions . a2a . v1 . tasks

+

Instance Methods

+

+ pushNotificationConfigs() +

+

Returns the pushNotificationConfigs Resource.

+ +

+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

+ cancel(name, a2aEndpoint, body=None, x__xgafv=None)

+

Send post request for reasoning engine instance via the A2A post protocol apis.

+

+ close()

+

Close httplib2 connections.

+

+ subscribe(name, a2aEndpoint, x__xgafv=None)

+

Stream get request for reasoning engine instance via the A2A stream get protocol apis.

+

Method Details

+
+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None) +
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ cancel(name, a2aEndpoint, body=None, x__xgafv=None) +
Send post request for reasoning engine instance via the A2A post protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send (required)
+  body: object, The request body.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ subscribe(name, a2aEndpoint, x__xgafv=None) +
Stream get request for reasoning engine instance via the A2A stream get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "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.reasoningEngines.runtimeRevisions.a2a.v1.tasks.pushNotificationConfigs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.pushNotificationConfigs.html new file mode 100644 index 0000000000..aa9de23a97 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.pushNotificationConfigs.html @@ -0,0 +1,110 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . runtimeRevisions . a2a . v1 . tasks . pushNotificationConfigs

+

Instance Methods

+

+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None) +
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.html index 9c4a3bc0da..63522cea07 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.html @@ -74,6 +74,11 @@

Vertex AI API . projects . locations . reasoningEngines . runtimeRevisions

Instance Methods

+

+ a2a() +

+

Returns the a2a Resource.

+

operations()

@@ -82,10 +87,401 @@

Instance Methods

close()

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a reasoning engine revision.

+

+ get(name, x__xgafv=None)

+

Gets a reasoning engine runtime revision.

+

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

+

Lists runtime revisions in a reasoning engine.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Queries using a reasoning engine.

+

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

+

Streams queries using a reasoning engine.

Method Details

close()
Close httplib2 connections.
+
+ delete(name, x__xgafv=None) +
Deletes a reasoning engine revision.
+
+Args:
+  name: string, Required. The name of the ReasoningEngineRuntimeRevision resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/runtimeRevisions/{runtime_revision}` (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 a reasoning engine runtime revision.
+
+Args:
+  name: string, Required. The name of the ReasoningEngineRuntimeRevision resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/runtimeRevisions/{runtimeRevision}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ReasoningEngineRuntimeRevision is a specific version of the runtime related part of ReasoningEngine. Contains only the fields that are revision specific.
+  "createTime": "A String", # Output only. Timestamp when this ReasoningEngineRuntimeRevision was created.
+  "name": "A String", # Identifier. The resource name of the ReasoningEngineRuntimeRevision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/runtimeRevisions/{runtime_revision}`
+  "spec": { # ReasoningEngine configurations # Immutable. Configurations of the ReasoningEngineRuntimeRevision. Contains only revision specific fields.
+    "agentCard": { # Optional. The A2A Agent Card for the agent (if available). It follows the specification at https://a2a-protocol.org/latest/specification/#5-agent-discovery-the-agent-card.
+      "a_key": "", # Properties of the object.
+    },
+    "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom".
+    "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format.
+      {
+        "a_key": "", # Properties of the object.
+      },
+    ],
+    "containerSpec": { # Specification for deploying from a container image. # Deploy from a container image with a defined entrypoint and commands.
+      "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.
+    },
+    "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment.
+      "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment.
+        "agentToAnywhereConfig": { # Configuration for traffic originating from a Reasoning Engine. # Optional. Configuration for traffic originating from the Reasoning Engine. When unset, outgoing traffic is not routed through an Agent Gateway.
+          "agentGateway": "A String", # Required. The resource name of the Agent Gateway for outbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `AGENT_TO_ANYWHERE`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}`
+        },
+        "clientToAgentConfig": { # Configuration for traffic targeting a Reasoning Engine. # Optional. Configuration for traffic targeting the Reasoning Engine. When unset, incoming traffic is not routed through an Agent Gateway.
+          "agentGateway": "A String", # Required. The resource name of the Agent Gateway to use for inbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `CLIENT_TO_AGENT`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}`
+        },
+      },
+      "agentServerMode": "A String", # The agent server mode.
+      "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.
+      "env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.
+        { # Represents an environment variable present in a Container or Python Module.
+          "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
+          "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
+        },
+      ],
+      "keepAliveProbe": { # Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. # Optional. Specifies the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings.
+        "httpGet": { # Specifies the HTTP GET configuration for the probe. # Optional. Specifies the HTTP GET configuration for the probe.
+          "path": "A String", # Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`).
+          "port": 42, # Optional. Specifies the port number on the container to which the request is sent.
+        },
+        "maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour).
+      },
+      "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100].
+      "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10].
+      "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
+        "dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
+          { # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
+            "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
+            "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
+            "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
+          },
+        ],
+        "networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+      },
+      "resourceLimits": { # Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * The only supported values for CPU are '1', '2', '4', '6' and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * The only supported values for memory are '1Gi', '2Gi', ... '32 Gi'. * For required cpu on different memory values, go to https://cloud.google.com/run/docs/configuring/memory-limits
+        "a_key": "A String",
+      },
+      "secretEnv": [ # Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.
+        { # Represents an environment variable where the value is a secret in Cloud Secret Manager.
+          "name": "A String", # Required. Name of the secret environment variable.
+          "secretRef": { # Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable. # Required. Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable.
+            "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name}.
+            "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias.
+          },
+        },
+      ],
+    },
+    "effectiveIdentity": "A String", # Output only. The identity to use for the Reasoning Engine. It can contain one of the following values: * service-{project}@gcp-sa-aiplatform-re.googleapis.com (for SERVICE_AGENT identity type) * {name}@{project}.gserviceaccount.com (for SERVICE_ACCOUNT identity type) * agents.global.{org}.system.id.goog/resources/aiplatform/projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine} (for AGENT_IDENTITY identity type)
+    "identityType": "A String", # Optional. The identity type to use for the Reasoning Engine. If not specified, the `service_account` field will be used if set, otherwise the default Vertex AI Reasoning Engine Service Agent in the project will be used.
+    "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified.
+      "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format.
+      "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object.
+      "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10.
+      "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file
+    },
+    "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used.
+    "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint.
+      "agentConfigSource": { # Specification for the deploying from agent config. # Source code is generated from the agent config.
+        "adkConfig": { # Configuration for the Agent Development Kit (ADK). # Required. The ADK configuration.
+          "jsonConfig": { # Required. The value of the ADK config in JSON format.
+            "a_key": "", # Properties of the object.
+          },
+        },
+        "inlineSource": { # Specifies source code provided as a byte stream. # Optional. Any additional files needed to interpret the config. If a `requirements.txt` file is present in the `inline_source`, the corresponding packages will be installed. If no `requirements.txt` file is present in `inline_source`, then the latest version of `google-adk` will be installed for interpreting the ADK config.
+          "sourceArchive": "A String", # Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file.
+        },
+      },
+      "developerConnectSource": { # Specifies source code to be fetched from a Git repository managed through the Developer Connect service. # Source code is in a Git repository managed by Developer Connect.
+        "config": { # Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect. This includes the repository, revision, and directory to use. # Required. The Developer Connect configuration that defines the specific repository, revision, and directory to use as the source code root.
+          "dir": "A String", # Required. Directory, relative to the source root, in which to run the build.
+          "gitRepositoryLink": "A String", # Required. The Developer Connect Git repository link, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`.
+          "revision": "A String", # Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.
+        },
+      },
+      "imageSpec": { # The image spec for building an image (within a single build step), based on the config file (i.e. Dockerfile) in the source directory. # Optional. Configuration for building an image with custom config file.
+        "buildArgs": { # Optional. Build arguments to be used. They will be passed through --build-arg flags.
+          "a_key": "A String",
+        },
+      },
+      "inlineSource": { # Specifies source code provided as a byte stream. # Source code is provided directly in the request.
+        "sourceArchive": "A String", # Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file.
+      },
+      "pythonSpec": { # Specification for running a Python application from source. # Configuration for a Python application.
+        "entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. This field should not be set if the source is `agent_config_source`.
+        "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". This field should not be set if the source is `agent_config_source`.
+        "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt".
+        "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10.
+      },
+    },
+  },
+  "state": "A String", # Output only. The state of the revision.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists runtime revisions in a reasoning engine.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to list the ReasoningEngineRuntimeRevisions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
+  pageSize: integer, Optional. The maximum number of ReasoningEngineRuntimeRevisions to return. The service may return fewer than this value. If unspecified, at most 50 revisions will be returned. The maximum value is 100; values above 100 will be coerced to 100.
+  pageToken: string, Optional. The standard list 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 ReasoningEngineRuntimeRevisionService.ListReasoningEngineRuntimeRevisions
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListReasoningEngineRuntimeRevisionsRequest.page_token to obtain that page.
+  "reasoningEngineRuntimeRevisions": [ # List of ReasoningEngineRuntimeRevisions in the requested page.
+    { # ReasoningEngineRuntimeRevision is a specific version of the runtime related part of ReasoningEngine. Contains only the fields that are revision specific.
+      "createTime": "A String", # Output only. Timestamp when this ReasoningEngineRuntimeRevision was created.
+      "name": "A String", # Identifier. The resource name of the ReasoningEngineRuntimeRevision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/runtimeRevisions/{runtime_revision}`
+      "spec": { # ReasoningEngine configurations # Immutable. Configurations of the ReasoningEngineRuntimeRevision. Contains only revision specific fields.
+        "agentCard": { # Optional. The A2A Agent Card for the agent (if available). It follows the specification at https://a2a-protocol.org/latest/specification/#5-agent-discovery-the-agent-card.
+          "a_key": "", # Properties of the object.
+        },
+        "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom".
+        "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format.
+          {
+            "a_key": "", # Properties of the object.
+          },
+        ],
+        "containerSpec": { # Specification for deploying from a container image. # Deploy from a container image with a defined entrypoint and commands.
+          "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.
+        },
+        "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment.
+          "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment.
+            "agentToAnywhereConfig": { # Configuration for traffic originating from a Reasoning Engine. # Optional. Configuration for traffic originating from the Reasoning Engine. When unset, outgoing traffic is not routed through an Agent Gateway.
+              "agentGateway": "A String", # Required. The resource name of the Agent Gateway for outbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `AGENT_TO_ANYWHERE`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}`
+            },
+            "clientToAgentConfig": { # Configuration for traffic targeting a Reasoning Engine. # Optional. Configuration for traffic targeting the Reasoning Engine. When unset, incoming traffic is not routed through an Agent Gateway.
+              "agentGateway": "A String", # Required. The resource name of the Agent Gateway to use for inbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `CLIENT_TO_AGENT`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}`
+            },
+          },
+          "agentServerMode": "A String", # The agent server mode.
+          "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.
+          "env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.
+            { # Represents an environment variable present in a Container or Python Module.
+              "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier.
+              "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.
+            },
+          ],
+          "keepAliveProbe": { # Represents the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings. # Optional. Specifies the configuration for keep-alive probe. Contains configuration on a specified endpoint that a deployment host should use to keep the container alive based on the probe settings.
+            "httpGet": { # Specifies the HTTP GET configuration for the probe. # Optional. Specifies the HTTP GET configuration for the probe.
+              "path": "A String", # Required. Specifies the path of the HTTP GET request (e.g., `"/is_busy"`).
+              "port": 42, # Optional. Specifies the port number on the container to which the request is sent.
+            },
+            "maxSeconds": 42, # Optional. Specifies the maximum duration (in seconds) to keep the instance alive via this probe. Can be a maximum of 3600 seconds (1 hour).
+          },
+          "maxInstances": 42, # Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100].
+          "minInstances": 42, # Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10].
+          "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I.
+            "dnsPeeringConfigs": [ # Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project.
+              { # DNS peering configuration. These configurations are used to create DNS peering zones in the Vertex tenant project VPC, enabling resolution of records within the specified domain hosted in the target network's Cloud DNS.
+                "domain": "A String", # Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot.
+                "targetNetwork": "A String", # Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.
+                "targetProject": "A String", # Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.
+              },
+            ],
+            "networkAttachment": "A String", # Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+          },
+          "resourceLimits": { # Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * The only supported values for CPU are '1', '2', '4', '6' and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * The only supported values for memory are '1Gi', '2Gi', ... '32 Gi'. * For required cpu on different memory values, go to https://cloud.google.com/run/docs/configuring/memory-limits
+            "a_key": "A String",
+          },
+          "secretEnv": [ # Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.
+            { # Represents an environment variable where the value is a secret in Cloud Secret Manager.
+              "name": "A String", # Required. Name of the secret environment variable.
+              "secretRef": { # Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable. # Required. Reference to a secret stored in the Cloud Secret Manager that will provide the value for this environment variable.
+                "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name}.
+                "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias.
+              },
+            },
+          ],
+        },
+        "effectiveIdentity": "A String", # Output only. The identity to use for the Reasoning Engine. It can contain one of the following values: * service-{project}@gcp-sa-aiplatform-re.googleapis.com (for SERVICE_AGENT identity type) * {name}@{project}.gserviceaccount.com (for SERVICE_ACCOUNT identity type) * agents.global.{org}.system.id.goog/resources/aiplatform/projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine} (for AGENT_IDENTITY identity type)
+        "identityType": "A String", # Optional. The identity type to use for the Reasoning Engine. If not specified, the `service_account` field will be used if set, otherwise the default Vertex AI Reasoning Engine Service Agent in the project will be used.
+        "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified.
+          "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format.
+          "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object.
+          "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, the default value is 3.10.
+          "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file
+        },
+        "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used.
+        "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint.
+          "agentConfigSource": { # Specification for the deploying from agent config. # Source code is generated from the agent config.
+            "adkConfig": { # Configuration for the Agent Development Kit (ADK). # Required. The ADK configuration.
+              "jsonConfig": { # Required. The value of the ADK config in JSON format.
+                "a_key": "", # Properties of the object.
+              },
+            },
+            "inlineSource": { # Specifies source code provided as a byte stream. # Optional. Any additional files needed to interpret the config. If a `requirements.txt` file is present in the `inline_source`, the corresponding packages will be installed. If no `requirements.txt` file is present in `inline_source`, then the latest version of `google-adk` will be installed for interpreting the ADK config.
+              "sourceArchive": "A String", # Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file.
+            },
+          },
+          "developerConnectSource": { # Specifies source code to be fetched from a Git repository managed through the Developer Connect service. # Source code is in a Git repository managed by Developer Connect.
+            "config": { # Specifies the configuration for fetching source code from a Git repository that is managed by Developer Connect. This includes the repository, revision, and directory to use. # Required. The Developer Connect configuration that defines the specific repository, revision, and directory to use as the source code root.
+              "dir": "A String", # Required. Directory, relative to the source root, in which to run the build.
+              "gitRepositoryLink": "A String", # Required. The Developer Connect Git repository link, formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`.
+              "revision": "A String", # Required. The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref.
+            },
+          },
+          "imageSpec": { # The image spec for building an image (within a single build step), based on the config file (i.e. Dockerfile) in the source directory. # Optional. Configuration for building an image with custom config file.
+            "buildArgs": { # Optional. Build arguments to be used. They will be passed through --build-arg flags.
+              "a_key": "A String",
+            },
+          },
+          "inlineSource": { # Specifies source code provided as a byte stream. # Source code is provided directly in the request.
+            "sourceArchive": "A String", # Required. Input only. The application source code archive. It must be a compressed tarball (.tar.gz) file.
+          },
+          "pythonSpec": { # Specification for running a Python application from source. # Configuration for a Python application.
+            "entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. This field should not be set if the source is `agent_config_source`.
+            "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". This field should not be set if the source is `agent_config_source`.
+            "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt".
+            "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13, 3.14. If not specified, default value is 3.10.
+          },
+        },
+      },
+      "state": "A String", # Output only. The state of the revision.
+    },
+  ],
+}
+
+ +
+ 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.
+        
+
+ +
+ query(name, body=None, x__xgafv=None) +
Queries using a reasoning engine.
+
+Args:
+  name: string, Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ReasoningEngineExecutionService.Query.
+  "classMethod": "A String", # Optional. Class method to be used for the query. It is optional and defaults to "query" if unspecified.
+  "input": { # Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+  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 ReasoningEngineExecutionService.Query
+  "output": "", # Response provided by users in JSON object format.
+}
+
+ +
+ streamQuery(name, body=None, x__xgafv=None) +
Streams queries using a reasoning engine.
+
+Args:
+  name: string, Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ReasoningEngineExecutionService.StreamQuery.
+  "classMethod": "A String", # Optional. Class method to be used for the stream query. It is optional and defaults to "stream_query" if unspecified.
+  "input": { # Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "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.reasoningEngines.sandboxEnvironmentSnapshots.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.html new file mode 100644 index 0000000000..8d441bf4e9 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.html @@ -0,0 +1,218 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . sandboxEnvironmentSnapshots

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes the specific SandboxEnvironmentSnapshot.

+

+ get(name, x__xgafv=None)

+

Gets details of the specific SandboxEnvironmentSnapshot.

+

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

+

Lists SandboxEnvironmentSnapshots in a given reasoning engine.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes the specific SandboxEnvironmentSnapshot.
+
+Args:
+  name: string, Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}` (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 the specific SandboxEnvironmentSnapshot.
+
+Args:
+  name: string, Required. The resource name of the sandbox environment snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # SandboxEnvironmentSnapshot is a snapshot of the SandboxEnvironment.
+  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentSnapshot was created.
+  "displayName": "A String", # Required. The display name of the SandboxEnvironmentSnapshot.
+  "expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironmentSnapshot is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+  "name": "A String", # Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
+  "owner": "A String", # Optional. Owner information for this sandbox snapshot. Different owners will have isolations on snapshot storage and identity. If not set, snapshot will be created as the default owner.
+  "parentSnapshot": "A String", # Output only. The resource name of the parent SandboxEnvironmentSnapshot. Empty if this is a root Snapshot (the first snapshot from a newly created sandbox). Can be used to reconstruct the whole ancestry tree of snapshots.
+  "postSnapshotAction": "A String", # Optional. Input only. Action to take on the source SandboxEnvironment after the snapshot is taken. This field is only used in CreateSandboxEnvironmentSnapshotRequest and it is not stored in the resource.
+  "sizeBytes": "A String", # Optional. Output only. Size of the snapshot data in bytes.
+  "sourceSandboxEnvironment": "A String", # Required. The resource name of the source SandboxEnvironment this snapshot was taken from.
+  "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently updated.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists SandboxEnvironmentSnapshots in a given reasoning engine.
+
+Args:
+  parent: string, Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
+  pageSize: integer, Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100.
+  pageToken: string, Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page.
+  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 SandboxEnvironmentService.ListSandboxEnvironmentSnapshots.
+  "nextPageToken": "A String", # A token, which can be sent as ListSandboxEnvironmentSnapshotsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.
+  "sandboxEnvironmentSnapshots": [ # The SandboxEnvironmentSnapshots matching the request.
+    { # SandboxEnvironmentSnapshot is a snapshot of the SandboxEnvironment.
+      "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentSnapshot was created.
+      "displayName": "A String", # Required. The display name of the SandboxEnvironmentSnapshot.
+      "expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironmentSnapshot is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+      "name": "A String", # Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
+      "owner": "A String", # Optional. Owner information for this sandbox snapshot. Different owners will have isolations on snapshot storage and identity. If not set, snapshot will be created as the default owner.
+      "parentSnapshot": "A String", # Output only. The resource name of the parent SandboxEnvironmentSnapshot. Empty if this is a root Snapshot (the first snapshot from a newly created sandbox). Can be used to reconstruct the whole ancestry tree of snapshots.
+      "postSnapshotAction": "A String", # Optional. Input only. Action to take on the source SandboxEnvironment after the snapshot is taken. This field is only used in CreateSandboxEnvironmentSnapshotRequest and it is not stored in the resource.
+      "sizeBytes": "A String", # Optional. Output only. Size of the snapshot data in bytes.
+      "sourceSandboxEnvironment": "A String", # Required. The resource name of the source SandboxEnvironment this snapshot was taken from.
+      "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.
+      "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently 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.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.html new file mode 100644 index 0000000000..8cbf1f48ae --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . sandboxEnvironmentSnapshots . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

+

+ 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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ 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.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # 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.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
+    "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.
+        
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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.reasoningEngines.sandboxEnvironmentTemplates.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html new file mode 100644 index 0000000000..1246c406d6 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html @@ -0,0 +1,330 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . sandboxEnvironmentTemplates

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates a SandboxEnvironmentTemplate in a given reasoning engine.

+

+ delete(name, x__xgafv=None)

+

Deletes the specific SandboxEnvironmentTemplate.

+

+ get(name, x__xgafv=None)

+

Gets details of the specific SandboxEnvironmentTemplate.

+

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

+

Lists SandboxEnvironmentTemplates in a given reasoning engine.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a SandboxEnvironmentTemplate in a given reasoning engine.
+
+Args:
+  parent: string, Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The specification of a SandboxEnvironmentTemplate. A SandboxEnvironmentTemplate defines a template for creating SandboxEnvironments.
+  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was created.
+  "customContainerEnvironment": { # The customized sandbox runtime environment for BYOC. # The sandbox environment for custom container workloads.
+    "customContainerSpec": { # Specification for deploying from a custom container image. # The specification of the custom container environment.
+      "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.
+    },
+    "ports": [ # Ports to expose from the container.
+      { # Represents a network port in a container.
+        "port": 42, # Optional. Port number to expose. This must be a valid port number, between 1 and 65535.
+        "protocol": "A String", # Optional. Protocol for port. Defaults to TCP if not specified.
+      },
+    ],
+    "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Resource requests and limits for the container.
+      "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi").
+        "a_key": "A String",
+      },
+      "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi").
+        "a_key": "A String",
+      },
+    },
+  },
+  "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads.
+    "defaultContainerCategory": "A String", # Required. The category of the default container image.
+  },
+  "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+  "name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
+  "state": "A String", # Output only. The state of the sandbox environment template.
+  "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
+  "warmPoolConfig": { # Configuration for a warm pool of sandbox instances. # Optional. The configuration for the warm pool of this template.
+    "targetInstanceCount": 42, # Optional. The target number of pre-warmed instances to maintain.
+  },
+}
+
+  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 the specific SandboxEnvironmentTemplate.
+
+Args:
+  name: string, Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` (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 the specific SandboxEnvironmentTemplate.
+
+Args:
+  name: string, Required. The resource name of the sandbox environment template. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The specification of a SandboxEnvironmentTemplate. A SandboxEnvironmentTemplate defines a template for creating SandboxEnvironments.
+  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was created.
+  "customContainerEnvironment": { # The customized sandbox runtime environment for BYOC. # The sandbox environment for custom container workloads.
+    "customContainerSpec": { # Specification for deploying from a custom container image. # The specification of the custom container environment.
+      "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.
+    },
+    "ports": [ # Ports to expose from the container.
+      { # Represents a network port in a container.
+        "port": 42, # Optional. Port number to expose. This must be a valid port number, between 1 and 65535.
+        "protocol": "A String", # Optional. Protocol for port. Defaults to TCP if not specified.
+      },
+    ],
+    "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Resource requests and limits for the container.
+      "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi").
+        "a_key": "A String",
+      },
+      "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi").
+        "a_key": "A String",
+      },
+    },
+  },
+  "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads.
+    "defaultContainerCategory": "A String", # Required. The category of the default container image.
+  },
+  "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+  "name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
+  "state": "A String", # Output only. The state of the sandbox environment template.
+  "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
+  "warmPoolConfig": { # Configuration for a warm pool of sandbox instances. # Optional. The configuration for the warm pool of this template.
+    "targetInstanceCount": 42, # Optional. The target number of pre-warmed instances to maintain.
+  },
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists SandboxEnvironmentTemplates in a given reasoning engine.
+
+Args:
+  parent: string, Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
+  pageSize: integer, Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned.
+  pageToken: string, Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page.
+  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 SandboxEnvironmentService.ListSandboxEnvironmentTemplates.
+  "nextPageToken": "A String", # A token, which can be sent as ListSandboxEnvironmentTemplatesRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.
+  "sandboxEnvironmentTemplates": [ # The SandboxEnvironmentTemplates matching the request.
+    { # The specification of a SandboxEnvironmentTemplate. A SandboxEnvironmentTemplate defines a template for creating SandboxEnvironments.
+      "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was created.
+      "customContainerEnvironment": { # The customized sandbox runtime environment for BYOC. # The sandbox environment for custom container workloads.
+        "customContainerSpec": { # Specification for deploying from a custom container image. # The specification of the custom container environment.
+          "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.
+        },
+        "ports": [ # Ports to expose from the container.
+          { # Represents a network port in a container.
+            "port": 42, # Optional. Port number to expose. This must be a valid port number, between 1 and 65535.
+            "protocol": "A String", # Optional. Protocol for port. Defaults to TCP if not specified.
+          },
+        ],
+        "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Resource requests and limits for the container.
+          "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi").
+            "a_key": "A String",
+          },
+          "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi").
+            "a_key": "A String",
+          },
+        },
+      },
+      "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads.
+        "defaultContainerCategory": "A String", # Required. The category of the default container image.
+      },
+      "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+      "name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
+      "state": "A String", # Output only. The state of the sandbox environment template.
+      "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
+      "warmPoolConfig": { # Configuration for a warm pool of sandbox instances. # Optional. The configuration for the warm pool of this template.
+        "targetInstanceCount": 42, # Optional. The target number of pre-warmed instances to maintain.
+      },
+    },
+  ],
+}
+
+ +
+ 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/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.html new file mode 100644 index 0000000000..5c42284213 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . sandboxEnvironmentTemplates . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

+

+ 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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ 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.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # 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.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
+    "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.
+        
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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.reasoningEngines.sandboxEnvironments.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html index 1f90a20867..3bf835c360 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironments.html @@ -100,6 +100,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

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

+

Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.

Method Details

close() @@ -119,6 +122,7 @@

Method Details

"connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment. "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer. "loadBalancerIp": "A String", # Output only. The IP address of the load balancer. + "sandboxHostname": "A String", # Output only. The hostname of the SandboxEnvironment. "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment. }, "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created. @@ -266,6 +270,7 @@

Method Details

"connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment. "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer. "loadBalancerIp": "A String", # Output only. The IP address of the load balancer. + "sandboxHostname": "A String", # Output only. The hostname of the SandboxEnvironment. "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment. }, "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created. @@ -310,6 +315,7 @@

Method Details

"connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment. "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer. "loadBalancerIp": "A String", # Output only. The IP address of the load balancer. + "sandboxHostname": "A String", # Output only. The hostname of the SandboxEnvironment. "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment. }, "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created. @@ -346,4 +352,56 @@

Method Details

+
+ snapshot(name, body=None, x__xgafv=None) +
Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.
+
+Args:
+  name: string, Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # SandboxEnvironmentSnapshot is a snapshot of the SandboxEnvironment.
+  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentSnapshot was created.
+  "displayName": "A String", # Required. The display name of the SandboxEnvironmentSnapshot.
+  "expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironmentSnapshot is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+  "name": "A String", # Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
+  "owner": "A String", # Optional. Owner information for this sandbox snapshot. Different owners will have isolations on snapshot storage and identity. If not set, snapshot will be created as the default owner.
+  "parentSnapshot": "A String", # Output only. The resource name of the parent SandboxEnvironmentSnapshot. Empty if this is a root Snapshot (the first snapshot from a newly created sandbox). Can be used to reconstruct the whole ancestry tree of snapshots.
+  "postSnapshotAction": "A String", # Optional. Input only. Action to take on the source SandboxEnvironment after the snapshot is taken. This field is only used in CreateSandboxEnvironmentSnapshotRequest and it is not stored in the resource.
+  "sizeBytes": "A String", # Optional. Output only. Size of the snapshot data in bytes.
+  "sourceSandboxEnvironment": "A String", # Required. The resource name of the source SandboxEnvironment this snapshot was taken from.
+  "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently 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.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html index 921fd09d03..d594f8ea5f 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html @@ -242,6 +242,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/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html index 5dab795fdd..040f443c5d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html @@ -250,6 +250,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/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html index 61670413df..a06514f2cf 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html @@ -691,6 +691,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -1993,6 +1998,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -3302,6 +3312,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -4617,6 +4632,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -6124,6 +6144,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index 03ec537fff..d5725c6800 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -1476,6 +1476,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. @@ -3636,6 +3638,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/aiplatform_v1beta1.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html index 5bb583fed2..b1b774f1e9 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html @@ -104,6 +104,16 @@

Instance Methods

Returns the runtimeRevisions Resource.

+

+ sandboxEnvironmentSnapshots() +

+

Returns the sandboxEnvironmentSnapshots Resource.

+ +

+ sandboxEnvironmentTemplates() +

+

Returns the sandboxEnvironmentTemplates Resource.

+

sandboxEnvironments()

@@ -162,17 +172,18 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Represents configuration for organizing memories for a particular scope. + { # Represents configuration for organizing natural language memories for a particular scope. "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. - "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + "revisionsPerCandidateCount": 42, # Optional. Represents the maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. }, - "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") - "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. + "disableNaturalLanguageMemories": True or False, # Optional. Indicates whether natural language memory generation should be disabled for all requests. By default, natural language memory generation is enabled. Set this to `true` when you only want to generate structured memories. + "enableThirdPersonMemories": True or False, # Optional. Indicates whether the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") + "generateMemoriesExamples": [ # Optional. Provides examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. "conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. - "events": [ # Optional. The input conversation events for the example. + "events": [ # Optional. Represents the input conversation events for the example. { # A single conversation event. - "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. + "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. Represents the content of the event. "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. @@ -251,42 +262,101 @@

Method Details

}, ], }, - "generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. + "generatedMemories": [ # Optional. Represents the memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. - "fact": "A String", # Required. The fact to generate a memory from. - "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + "fact": "A String", # Required. Represents the fact to generate a memory from. + "topics": [ # Optional. Represents the list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], }, ], }, ], - "memoryTopics": [ # Optional. Topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. + "memoryTopics": [ # Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. { # A topic of information that should be extracted from conversations and stored as memories. "customMemoryTopic": { # A custom memory topic defined by the developer. # A custom memory topic defined by the developer. - "description": "A String", # Required. Description of the memory topic. This should explain what information should be extracted for this topic. - "label": "A String", # Required. The label of the topic. + "description": "A String", # Required. Represents the description of the memory topic. This should explain what information should be extracted for this topic. + "label": "A String", # Required. Represents the label of the topic. }, "managedMemoryTopic": { # A managed memory topic defined by the system. # A managed memory topic defined by Memory Bank. - "managedTopicEnum": "A String", # Required. The managed topic. + "managedTopicEnum": "A String", # Required. Represents the managed topic. }, }, ], - "scopeKeys": [ # Optional. The scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. "A String", ], }, ], "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. - "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. + "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Specifies the default trigger configuration for generating memories using `IngestEvents`. + "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately. + "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. + "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. + "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + }, + }, + "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, "similaritySearchConfig": { # Configuration for how to perform similarity search on memories. # Optional. Configuration for how to perform similarity search on memories. If not set, the Memory Bank will use the default embedding model `text-embedding-005`. "embeddingModel": "A String", # Required. The model used to generate embeddings to lookup similar memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, + "structuredMemoryConfigs": [ # Optional. Configuration for organizing structured memories for a particular scope. + { # Represents configuration for organizing structured memories for a particular scope. + "schemaConfigs": [ # Optional. Represents configuration of the structured memories' schemas. + { # Schema configuration for structured memories. + "id": "A String", # Required. Represents the ID of the schema. Must be 1-63 characters, start with a lowercase letter, and consist of lowercase letters, numbers, and hyphens. + "memoryType": "A String", # Optional. Represents the type of the structured memories associated with the schema. If not set, then `STRUCTURED_PROFILE` will be used. + "schema": { # 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). # Required. Represents the OpenAPI schema of the structured memories. The schema `type` cannot be `ARRAY` when `memory_type` is `STRUCTURED_PROFILE`. + "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. + }, + }, + ], + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "A String", + ], + }, + ], "ttlConfig": { # Configuration for automatically setting the TTL ("time-to-live") of the memories in the Memory Bank. # Optional. Configuration for automatic TTL ("time-to-live") of the memories in the Memory Bank. If not set, TTL will not be applied automatically. The TTL can be explicitly set by modifying the `expire_time` of each Memory resource. "defaultTtl": "A String", # Optional. The default TTL duration of the memories in the Memory Bank. This applies to all operations that create or update a memory. "granularTtlConfig": { # Configuration for TTL of the memories in the Memory Bank based on the action that created or updated the memory. # Optional. The granular TTL configuration of the memories in the Memory Bank. @@ -323,6 +393,14 @@

Method Details

"imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. + "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. + "agentToAnywhereConfig": { # Configuration for traffic originating from a Reasoning Engine. # Optional. Configuration for traffic originating from the Reasoning Engine. When unset, outgoing traffic is not routed through an Agent Gateway. + "agentGateway": "A String", # Required. The resource name of the Agent Gateway for outbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `AGENT_TO_ANYWHERE`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}` + }, + "clientToAgentConfig": { # Configuration for traffic targeting a Reasoning Engine. # Optional. Configuration for traffic targeting the Reasoning Engine. When unset, incoming traffic is not routed through an Agent Gateway. + "agentGateway": "A String", # Required. The resource name of the Agent Gateway to use for inbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `CLIENT_TO_AGENT`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}` + }, + }, "agentServerMode": "A String", # The agent server mode. "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9. "env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API. @@ -406,6 +484,18 @@

Method Details

}, }, }, + "trafficConfig": { # Traffic distribution configuration. # Optional. Traffic distribution configuration for the Reasoning Engine. + "trafficSplitAlwaysLatest": { # Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision. # Optional. Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision. + }, + "trafficSplitManual": { # Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each. # Optional. Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each. + "targets": [ # A list of traffic targets for the Runtimes Revisions. The sum of percentages must equal to 100. + { # A single target for the traffic split, specifying a Runtime Revision and the percentage of traffic to send to it. + "percent": 42, # Required. Specifies percent of the traffic to this Runtime Revision. + "runtimeRevisionName": "A String", # Required. The Runtime Revision name to which to send this portion of traffic, if traffic allocation is by Runtime Revision. + }, + ], + }, + }, "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated. } @@ -539,17 +629,18 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Represents configuration for organizing memories for a particular scope. + { # Represents configuration for organizing natural language memories for a particular scope. "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. - "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + "revisionsPerCandidateCount": 42, # Optional. Represents the maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. }, - "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") - "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. + "disableNaturalLanguageMemories": True or False, # Optional. Indicates whether natural language memory generation should be disabled for all requests. By default, natural language memory generation is enabled. Set this to `true` when you only want to generate structured memories. + "enableThirdPersonMemories": True or False, # Optional. Indicates whether the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") + "generateMemoriesExamples": [ # Optional. Provides examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. "conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. - "events": [ # Optional. The input conversation events for the example. + "events": [ # Optional. Represents the input conversation events for the example. { # A single conversation event. - "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. + "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. Represents the content of the event. "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. @@ -628,42 +719,101 @@

Method Details

}, ], }, - "generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. + "generatedMemories": [ # Optional. Represents the memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. - "fact": "A String", # Required. The fact to generate a memory from. - "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + "fact": "A String", # Required. Represents the fact to generate a memory from. + "topics": [ # Optional. Represents the list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], }, ], }, ], - "memoryTopics": [ # Optional. Topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. + "memoryTopics": [ # Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. { # A topic of information that should be extracted from conversations and stored as memories. "customMemoryTopic": { # A custom memory topic defined by the developer. # A custom memory topic defined by the developer. - "description": "A String", # Required. Description of the memory topic. This should explain what information should be extracted for this topic. - "label": "A String", # Required. The label of the topic. + "description": "A String", # Required. Represents the description of the memory topic. This should explain what information should be extracted for this topic. + "label": "A String", # Required. Represents the label of the topic. }, "managedMemoryTopic": { # A managed memory topic defined by the system. # A managed memory topic defined by Memory Bank. - "managedTopicEnum": "A String", # Required. The managed topic. + "managedTopicEnum": "A String", # Required. Represents the managed topic. }, }, ], - "scopeKeys": [ # Optional. The scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. "A String", ], }, ], "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. - "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. + "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Specifies the default trigger configuration for generating memories using `IngestEvents`. + "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately. + "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. + "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. + "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + }, + }, + "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, "similaritySearchConfig": { # Configuration for how to perform similarity search on memories. # Optional. Configuration for how to perform similarity search on memories. If not set, the Memory Bank will use the default embedding model `text-embedding-005`. "embeddingModel": "A String", # Required. The model used to generate embeddings to lookup similar memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, + "structuredMemoryConfigs": [ # Optional. Configuration for organizing structured memories for a particular scope. + { # Represents configuration for organizing structured memories for a particular scope. + "schemaConfigs": [ # Optional. Represents configuration of the structured memories' schemas. + { # Schema configuration for structured memories. + "id": "A String", # Required. Represents the ID of the schema. Must be 1-63 characters, start with a lowercase letter, and consist of lowercase letters, numbers, and hyphens. + "memoryType": "A String", # Optional. Represents the type of the structured memories associated with the schema. If not set, then `STRUCTURED_PROFILE` will be used. + "schema": { # 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). # Required. Represents the OpenAPI schema of the structured memories. The schema `type` cannot be `ARRAY` when `memory_type` is `STRUCTURED_PROFILE`. + "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. + }, + }, + ], + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "A String", + ], + }, + ], "ttlConfig": { # Configuration for automatically setting the TTL ("time-to-live") of the memories in the Memory Bank. # Optional. Configuration for automatic TTL ("time-to-live") of the memories in the Memory Bank. If not set, TTL will not be applied automatically. The TTL can be explicitly set by modifying the `expire_time` of each Memory resource. "defaultTtl": "A String", # Optional. The default TTL duration of the memories in the Memory Bank. This applies to all operations that create or update a memory. "granularTtlConfig": { # Configuration for TTL of the memories in the Memory Bank based on the action that created or updated the memory. # Optional. The granular TTL configuration of the memories in the Memory Bank. @@ -700,6 +850,14 @@

Method Details

"imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. + "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. + "agentToAnywhereConfig": { # Configuration for traffic originating from a Reasoning Engine. # Optional. Configuration for traffic originating from the Reasoning Engine. When unset, outgoing traffic is not routed through an Agent Gateway. + "agentGateway": "A String", # Required. The resource name of the Agent Gateway for outbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `AGENT_TO_ANYWHERE`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}` + }, + "clientToAgentConfig": { # Configuration for traffic targeting a Reasoning Engine. # Optional. Configuration for traffic targeting the Reasoning Engine. When unset, incoming traffic is not routed through an Agent Gateway. + "agentGateway": "A String", # Required. The resource name of the Agent Gateway to use for inbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `CLIENT_TO_AGENT`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}` + }, + }, "agentServerMode": "A String", # The agent server mode. "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9. "env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API. @@ -783,6 +941,18 @@

Method Details

}, }, }, + "trafficConfig": { # Traffic distribution configuration. # Optional. Traffic distribution configuration for the Reasoning Engine. + "trafficSplitAlwaysLatest": { # Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision. # Optional. Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision. + }, + "trafficSplitManual": { # Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each. # Optional. Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each. + "targets": [ # A list of traffic targets for the Runtimes Revisions. The sum of percentages must equal to 100. + { # A single target for the traffic split, specifying a Runtime Revision and the percentage of traffic to send to it. + "percent": 42, # Required. Specifies percent of the traffic to this Runtime Revision. + "runtimeRevisionName": "A String", # Required. The Runtime Revision name to which to send this portion of traffic, if traffic allocation is by Runtime Revision. + }, + ], + }, + }, "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated. } @@ -811,17 +981,18 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Represents configuration for organizing memories for a particular scope. + { # Represents configuration for organizing natural language memories for a particular scope. "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. - "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + "revisionsPerCandidateCount": 42, # Optional. Represents the maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. }, - "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") - "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. + "disableNaturalLanguageMemories": True or False, # Optional. Indicates whether natural language memory generation should be disabled for all requests. By default, natural language memory generation is enabled. Set this to `true` when you only want to generate structured memories. + "enableThirdPersonMemories": True or False, # Optional. Indicates whether the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") + "generateMemoriesExamples": [ # Optional. Provides examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. "conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. - "events": [ # Optional. The input conversation events for the example. + "events": [ # Optional. Represents the input conversation events for the example. { # A single conversation event. - "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. + "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. Represents the content of the event. "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. @@ -900,42 +1071,101 @@

Method Details

}, ], }, - "generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. + "generatedMemories": [ # Optional. Represents the memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. - "fact": "A String", # Required. The fact to generate a memory from. - "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + "fact": "A String", # Required. Represents the fact to generate a memory from. + "topics": [ # Optional. Represents the list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], }, ], }, ], - "memoryTopics": [ # Optional. Topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. + "memoryTopics": [ # Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. { # A topic of information that should be extracted from conversations and stored as memories. "customMemoryTopic": { # A custom memory topic defined by the developer. # A custom memory topic defined by the developer. - "description": "A String", # Required. Description of the memory topic. This should explain what information should be extracted for this topic. - "label": "A String", # Required. The label of the topic. + "description": "A String", # Required. Represents the description of the memory topic. This should explain what information should be extracted for this topic. + "label": "A String", # Required. Represents the label of the topic. }, "managedMemoryTopic": { # A managed memory topic defined by the system. # A managed memory topic defined by Memory Bank. - "managedTopicEnum": "A String", # Required. The managed topic. + "managedTopicEnum": "A String", # Required. Represents the managed topic. }, }, ], - "scopeKeys": [ # Optional. The scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. "A String", ], }, ], "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. - "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. + "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Specifies the default trigger configuration for generating memories using `IngestEvents`. + "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately. + "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. + "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. + "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + }, + }, + "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, "similaritySearchConfig": { # Configuration for how to perform similarity search on memories. # Optional. Configuration for how to perform similarity search on memories. If not set, the Memory Bank will use the default embedding model `text-embedding-005`. "embeddingModel": "A String", # Required. The model used to generate embeddings to lookup similar memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, + "structuredMemoryConfigs": [ # Optional. Configuration for organizing structured memories for a particular scope. + { # Represents configuration for organizing structured memories for a particular scope. + "schemaConfigs": [ # Optional. Represents configuration of the structured memories' schemas. + { # Schema configuration for structured memories. + "id": "A String", # Required. Represents the ID of the schema. Must be 1-63 characters, start with a lowercase letter, and consist of lowercase letters, numbers, and hyphens. + "memoryType": "A String", # Optional. Represents the type of the structured memories associated with the schema. If not set, then `STRUCTURED_PROFILE` will be used. + "schema": { # 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). # Required. Represents the OpenAPI schema of the structured memories. The schema `type` cannot be `ARRAY` when `memory_type` is `STRUCTURED_PROFILE`. + "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. + }, + }, + ], + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "A String", + ], + }, + ], "ttlConfig": { # Configuration for automatically setting the TTL ("time-to-live") of the memories in the Memory Bank. # Optional. Configuration for automatic TTL ("time-to-live") of the memories in the Memory Bank. If not set, TTL will not be applied automatically. The TTL can be explicitly set by modifying the `expire_time` of each Memory resource. "defaultTtl": "A String", # Optional. The default TTL duration of the memories in the Memory Bank. This applies to all operations that create or update a memory. "granularTtlConfig": { # Configuration for TTL of the memories in the Memory Bank based on the action that created or updated the memory. # Optional. The granular TTL configuration of the memories in the Memory Bank. @@ -972,6 +1202,14 @@

Method Details

"imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. + "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. + "agentToAnywhereConfig": { # Configuration for traffic originating from a Reasoning Engine. # Optional. Configuration for traffic originating from the Reasoning Engine. When unset, outgoing traffic is not routed through an Agent Gateway. + "agentGateway": "A String", # Required. The resource name of the Agent Gateway for outbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `AGENT_TO_ANYWHERE`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}` + }, + "clientToAgentConfig": { # Configuration for traffic targeting a Reasoning Engine. # Optional. Configuration for traffic targeting the Reasoning Engine. When unset, incoming traffic is not routed through an Agent Gateway. + "agentGateway": "A String", # Required. The resource name of the Agent Gateway to use for inbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `CLIENT_TO_AGENT`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}` + }, + }, "agentServerMode": "A String", # The agent server mode. "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9. "env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API. @@ -1055,6 +1293,18 @@

Method Details

}, }, }, + "trafficConfig": { # Traffic distribution configuration. # Optional. Traffic distribution configuration for the Reasoning Engine. + "trafficSplitAlwaysLatest": { # Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision. # Optional. Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision. + }, + "trafficSplitManual": { # Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each. # Optional. Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each. + "targets": [ # A list of traffic targets for the Runtimes Revisions. The sum of percentages must equal to 100. + { # A single target for the traffic split, specifying a Runtime Revision and the percentage of traffic to send to it. + "percent": 42, # Required. Specifies percent of the traffic to this Runtime Revision. + "runtimeRevisionName": "A String", # Required. The Runtime Revision name to which to send this portion of traffic, if traffic allocation is by Runtime Revision. + }, + ], + }, + }, "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated. }, ], @@ -1088,17 +1338,18 @@

Method Details

"contextSpec": { # Configuration for how Agent Engine sub-resources should manage context. # Optional. Configuration for how Agent Engine sub-resources should manage context. "memoryBankConfig": { # Specification for a Memory Bank. # Optional. Specification for a Memory Bank, which manages memories for the Agent Engine. "customizationConfigs": [ # Optional. Configuration for how to customize Memory Bank behavior for a particular scope. - { # Represents configuration for organizing memories for a particular scope. + { # Represents configuration for organizing natural language memories for a particular scope. "consolidationConfig": { # Represents configuration for customizing how memories are consolidated. # Optional. Represents configuration for customizing how memories are consolidated together. - "revisionsPerCandidateCount": 42, # Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. + "revisionsPerCandidateCount": 42, # Optional. Represents the maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered. }, - "enableThirdPersonMemories": True or False, # Optional. If true, then the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") - "generateMemoriesExamples": [ # Optional. Examples of how to generate memories for a particular scope. + "disableNaturalLanguageMemories": True or False, # Optional. Indicates whether natural language memory generation should be disabled for all requests. By default, natural language memory generation is enabled. Set this to `true` when you only want to generate structured memories. + "enableThirdPersonMemories": True or False, # Optional. Indicates whether the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.") + "generateMemoriesExamples": [ # Optional. Provides examples of how to generate memories for a particular scope. { # An example of how to generate memories for a particular scope. "conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. - "events": [ # Optional. The input conversation events for the example. + "events": [ # Optional. Represents the input conversation events for the example. { # A single conversation event. - "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. + "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. Represents the content of the event. "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. @@ -1177,42 +1428,101 @@

Method Details

}, ], }, - "generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. + "generatedMemories": [ # Optional. Represents the memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. - "fact": "A String", # Required. The fact to generate a memory from. - "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + "fact": "A String", # Required. Represents the fact to generate a memory from. + "topics": [ # Optional. Represents the list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], }, ], }, ], - "memoryTopics": [ # Optional. Topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. + "memoryTopics": [ # Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used. { # A topic of information that should be extracted from conversations and stored as memories. "customMemoryTopic": { # A custom memory topic defined by the developer. # A custom memory topic defined by the developer. - "description": "A String", # Required. Description of the memory topic. This should explain what information should be extracted for this topic. - "label": "A String", # Required. The label of the topic. + "description": "A String", # Required. Represents the description of the memory topic. This should explain what information should be extracted for this topic. + "label": "A String", # Required. Represents the label of the topic. }, "managedMemoryTopic": { # A managed memory topic defined by the system. # A managed memory topic defined by Memory Bank. - "managedTopicEnum": "A String", # Required. The managed topic. + "managedTopicEnum": "A String", # Required. Represents the managed topic. }, }, ], - "scopeKeys": [ # Optional. The scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. "A String", ], }, ], "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. - "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. + "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Specifies the default trigger configuration for generating memories using `IngestEvents`. + "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately. + "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. + "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. + "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + }, + }, + "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, "similaritySearchConfig": { # Configuration for how to perform similarity search on memories. # Optional. Configuration for how to perform similarity search on memories. If not set, the Memory Bank will use the default embedding model `text-embedding-005`. "embeddingModel": "A String", # Required. The model used to generate embeddings to lookup similar memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, + "structuredMemoryConfigs": [ # Optional. Configuration for organizing structured memories for a particular scope. + { # Represents configuration for organizing structured memories for a particular scope. + "schemaConfigs": [ # Optional. Represents configuration of the structured memories' schemas. + { # Schema configuration for structured memories. + "id": "A String", # Required. Represents the ID of the schema. Must be 1-63 characters, start with a lowercase letter, and consist of lowercase letters, numbers, and hyphens. + "memoryType": "A String", # Optional. Represents the type of the structured memories associated with the schema. If not set, then `STRUCTURED_PROFILE` will be used. + "schema": { # 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). # Required. Represents the OpenAPI schema of the structured memories. The schema `type` cannot be `ARRAY` when `memory_type` is `STRUCTURED_PROFILE`. + "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. + }, + }, + ], + "scopeKeys": [ # Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank. + "A String", + ], + }, + ], "ttlConfig": { # Configuration for automatically setting the TTL ("time-to-live") of the memories in the Memory Bank. # Optional. Configuration for automatic TTL ("time-to-live") of the memories in the Memory Bank. If not set, TTL will not be applied automatically. The TTL can be explicitly set by modifying the `expire_time` of each Memory resource. "defaultTtl": "A String", # Optional. The default TTL duration of the memories in the Memory Bank. This applies to all operations that create or update a memory. "granularTtlConfig": { # Configuration for TTL of the memories in the Memory Bank based on the action that created or updated the memory. # Optional. The granular TTL configuration of the memories in the Memory Bank. @@ -1249,6 +1559,14 @@

Method Details

"imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. }, "deploymentSpec": { # The specification of a Reasoning Engine deployment. # Optional. The specification of a Reasoning Engine deployment. + "agentGatewayConfig": { # Agent Gateway configuration for a Reasoning Engine deployment. # Optional. Agent Gateway configuration for the Reasoning Engine deployment. + "agentToAnywhereConfig": { # Configuration for traffic originating from a Reasoning Engine. # Optional. Configuration for traffic originating from the Reasoning Engine. When unset, outgoing traffic is not routed through an Agent Gateway. + "agentGateway": "A String", # Required. The resource name of the Agent Gateway for outbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `AGENT_TO_ANYWHERE`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}` + }, + "clientToAgentConfig": { # Configuration for traffic targeting a Reasoning Engine. # Optional. Configuration for traffic targeting the Reasoning Engine. When unset, incoming traffic is not routed through an Agent Gateway. + "agentGateway": "A String", # Required. The resource name of the Agent Gateway to use for inbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `CLIENT_TO_AGENT`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}` + }, + }, "agentServerMode": "A String", # The agent server mode. "containerConcurrency": 42, # Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9. "env": [ # Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API. @@ -1332,6 +1650,18 @@

Method Details

}, }, }, + "trafficConfig": { # Traffic distribution configuration. # Optional. Traffic distribution configuration for the Reasoning Engine. + "trafficSplitAlwaysLatest": { # Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision. # Optional. Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision. + }, + "trafficSplitManual": { # Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each. # Optional. Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each. + "targets": [ # A list of traffic targets for the Runtimes Revisions. The sum of percentages must equal to 100. + { # A single target for the traffic split, specifying a Runtime Revision and the percentage of traffic to send to it. + "percent": 42, # Required. Specifies percent of the traffic to this Runtime Revision. + "runtimeRevisionName": "A String", # Required. The Runtime Revision name to which to send this portion of traffic, if traffic allocation is by Runtime Revision. + }, + ], + }, + }, "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated. } diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html index ab76865947..af1c3018d6 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html @@ -99,6 +99,9 @@

Instance Methods

get(name, x__xgafv=None)

Get a Memory.

+

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

+

Ingests events for a Memory Bank.

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

List Memories.

@@ -114,6 +117,9 @@

Instance Methods

retrieve(parent, body=None, x__xgafv=None)

Retrieve memories.

+

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

+

Retrieves profiles.

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

Rollback Memory to a specific revision.

@@ -133,37 +139,44 @@

Method Details

The object takes the form of: { # A memory. - "createTime": "A String", # Output only. Timestamp when this Memory was created. - "description": "A String", # Optional. Description of the Memory. - "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", # 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. + "createTime": "A String", # Output only. Represents the timestamp when this Memory was created. + "description": "A String", # Optional. Represents the description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request. + "displayName": "A String", # Optional. Represents the display name of the Memory. + "expireTime": "A String", # Optional. Represents the 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", # Optional. Represents semantic knowledge extracted from the source content. + "memoryType": "A String", # Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided. + "metadata": { # Optional. Represents 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. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, - "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` - "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. - "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request. "a_key": "A String", }, - "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. - "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. + "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL. + "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, - "topics": [ # Optional. The Topics of the Memory. + "structuredContent": { # Represents the structured value of the memory. # Optional. Represents the structured content of the memory. + "data": { # Required. Represents the structured value of the memory. + "a_key": "", # Properties of the object. + }, + "schemaId": "A String", # Required. Represents the schema ID for which this structured memory belongs to. + }, + "topics": [ # Optional. Represents the Topics of the Memory. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], - "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. - "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. + "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL. + "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated. } memoryId: string, Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number. @@ -241,6 +254,12 @@

Method Details

The object takes the form of: { # Request message for MemoryBankService.GenerateMemories. Maximum size is 8 MB. + "allowedTopics": [ # Optional. Restricts memory generation to a subset of memory topics. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. + }, + ], "directContentsSource": { # Defines a direct source of content from which to generate the memories. # Defines a direct source of content as the source content from which to generate memories. "events": [ # Required. The source content (i.e. chat history) to generate memories from. { # A single piece of conversation from which to generate memories. @@ -329,8 +348,8 @@

Method Details

"fact": "A String", # Required. The fact to consolidate with existing memories. "topics": [ # Optional. The topics that the consolidated memories should be associated with. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], }, @@ -340,10 +359,10 @@

Method Details

"disableMemoryRevisions": True or False, # Optional. If true, no revisions will be created for this request. "metadata": { # Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank. "a_key": { # Memory metadata. - "boolValue": True or False, # Boolean value. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, "metadataMergeStrategy": "A String", # Optional. The strategy to use when applying metadata to existing memories. @@ -406,37 +425,181 @@

Method Details

An object of the form: { # A memory. - "createTime": "A String", # Output only. Timestamp when this Memory was created. - "description": "A String", # Optional. Description of the Memory. - "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", # 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. + "createTime": "A String", # Output only. Represents the timestamp when this Memory was created. + "description": "A String", # Optional. Represents the description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request. + "displayName": "A String", # Optional. Represents the display name of the Memory. + "expireTime": "A String", # Optional. Represents the 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", # Optional. Represents semantic knowledge extracted from the source content. + "memoryType": "A String", # Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided. + "metadata": { # Optional. Represents 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. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, - "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` - "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. - "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request. "a_key": "A String", }, - "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. - "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. + "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL. + "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, - "topics": [ # Optional. The Topics of the Memory. + "structuredContent": { # Represents the structured value of the memory. # Optional. Represents the structured content of the memory. + "data": { # Required. Represents the structured value of the memory. + "a_key": "", # Properties of the object. + }, + "schemaId": "A String", # Required. Represents the schema ID for which this structured memory belongs to. + }, + "topics": [ # Optional. Represents the Topics of the Memory. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], - "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. - "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. + "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL. + "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated. +} + + +
+ ingestEvents(parent, body=None, x__xgafv=None) +
Ingests events for a Memory Bank.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.IngestEvents.
+  "directContentsSource": { # Ingest events directly from the request. # Ingest events directly from the request.
+    "events": [ # Required. The events to ingest.
+      { # A single event to ingest.
+        "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.
+          "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'.
+        },
+        "eventId": "A String", # Optional. A unique identifier for the event. If an event with the same event_id is ingested multiple times, it will be de-duplicated.
+        "eventTime": "A String", # Optional. The time at which the event occurred. If provided, this timestamp will be used for ordering events within a stream. If not provided, the server-side ingestion time will be used.
+      },
+    ],
+  },
+  "forceFlush": True or False, # Optional. Forces a flush of all pending events in the stream and triggers memory generation immediately bypassing any conditions configured in the `generation_trigger_config`.
+  "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Configuration for triggering memory generation from this ingestion. If not set, then the stream will be force flushed immediately.
+    "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately.
+      "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit.
+      "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity.
+      "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity.
+    },
+  },
+  "scope": { # Required. The scope of the memories that should be generated from the stream. Memories will be consolidated across memories with the same scope. Scope values cannot contain the wildcard character '*'.
+    "a_key": "A String",
+  },
+  "streamId": "A String", # Optional. The ID of the stream to ingest events into. If not provided, a new one will be created.
+}
+
+  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.
+  },
 }
@@ -461,37 +624,44 @@

Method Details

{ # Response message for MemoryBankService.ListMemories. "memories": [ # List of Memories in the requested page. { # A memory. - "createTime": "A String", # Output only. Timestamp when this Memory was created. - "description": "A String", # Optional. Description of the Memory. - "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", # 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. + "createTime": "A String", # Output only. Represents the timestamp when this Memory was created. + "description": "A String", # Optional. Represents the description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request. + "displayName": "A String", # Optional. Represents the display name of the Memory. + "expireTime": "A String", # Optional. Represents the 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", # Optional. Represents semantic knowledge extracted from the source content. + "memoryType": "A String", # Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided. + "metadata": { # Optional. Represents 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. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, - "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` - "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. - "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request. "a_key": "A String", }, - "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. - "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. + "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL. + "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, - "topics": [ # Optional. The Topics of the Memory. + "structuredContent": { # Represents the structured value of the memory. # Optional. Represents the structured content of the memory. + "data": { # Required. Represents the structured value of the memory. + "a_key": "", # Properties of the object. + }, + "schemaId": "A String", # Required. Represents the schema ID for which this structured memory belongs to. + }, + "topics": [ # Optional. Represents the Topics of the Memory. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], - "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. - "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. + "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL. + "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated. }, ], "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListMemoriesRequest.page_token to obtain that page. @@ -517,42 +687,49 @@

Method Details

Update a Memory.
 
 Args:
-  name: string, Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  name: string, Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
   body: object, The request body.
     The object takes the form of:
 
 { # A memory.
-  "createTime": "A String", # Output only. Timestamp when this Memory was created.
-  "description": "A String", # Optional. Description of the Memory.
-  "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", # 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.
+  "createTime": "A String", # Output only. Represents the timestamp when this Memory was created.
+  "description": "A String", # Optional. Represents the description of the Memory.
+  "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request.
+  "displayName": "A String", # Optional. Represents the display name of the Memory.
+  "expireTime": "A String", # Optional. Represents the 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", # Optional. Represents semantic knowledge extracted from the source content.
+  "memoryType": "A String", # Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided.
+  "metadata": { # Optional. Represents 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.
-      "doubleValue": 3.14, # Double value.
-      "stringValue": "A String", # String value.
-      "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+      "boolValue": True or False, # Represents a boolean value.
+      "doubleValue": 3.14, # Represents a double value.
+      "stringValue": "A String", # Represents a string value.
+      "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
     },
   },
-  "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
-  "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
-  "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request.
+  "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
+  "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+  "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
     "a_key": "A String",
   },
-  "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL.
-  "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
+  "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
+  "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
     "a_key": "A String",
   },
-  "topics": [ # Optional. The Topics of the Memory.
+  "structuredContent": { # Represents the structured value of the memory. # Optional. Represents the structured content of the memory.
+    "data": { # Required. Represents the structured value of the memory.
+      "a_key": "", # Properties of the object.
+    },
+    "schemaId": "A String", # Required. Represents the schema ID for which this structured memory belongs to.
+  },
+  "topics": [ # Optional. Represents the Topics of the Memory.
     { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
-      "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label.
-      "managedMemoryTopic": "A String", # Optional. The managed memory topic.
+      "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+      "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
     },
   ],
-  "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.
-  "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated.
+  "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated.
 }
 
   updateMask: string, Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`
@@ -598,16 +775,16 @@ 

Method Details

"filter": "A String", # Required. The standard list filter to determine which memories to purge. More detail in [AIP-160](https://google.aip.dev/160). "filterGroups": [ # Optional. Metadata filters that will be applied to the memories to be purged. Filters are defined using disjunctive normal form (OR of ANDs). For example: `filter_groups: [{filters: [{key: "author", value: {string_value: "agent 123"}, op: EQUAL}]}, {filters: [{key: "label", value: {string_value: "travel"}, op: EQUAL}, {key: "author", value: {string_value: "agent 321"}, op: EQUAL}]}]` would be equivalent to the logical expression: `(metadata.author = "agent 123" OR (metadata.label = "travel" AND metadata.author = "agent 321"))`. { # A conjunction of filters that will be combined using AND logic. - "filters": [ # Filters that will combined using AND logic. + "filters": [ # Represents filters that will be combined using AND logic. { # Filter to apply when retrieving memories. - "key": "A String", # Key of the filter. For example, "author" would apply to `metadata` entries with the key "author". - "negate": True or False, # If true, the filter will be negated. - "op": "A String", # Operator to apply to the filter. If not set, then EQUAL will be used. - "value": { # Memory metadata. # Value to compare to. - "boolValue": True or False, # Boolean value. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "key": "A String", # Represents the key of the filter. For example, "author" would apply to `metadata` entries with the key "author". + "negate": True or False, # Indicates whether the filter will be negated. + "op": "A String", # Represents the operator to apply to the filter. If not set, then EQUAL will be used. + "value": { # Memory metadata. # Represents the value to compare to. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, ], @@ -658,21 +835,24 @@

Method Details

"filter": "A String", # Optional. The standard list filter that will be applied to the retrieved memories. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `fact` * `create_time` * `update_time` * `topics` (i.e. `topics.custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES`) "filterGroups": [ # Optional. Metadata filters that will be applied to the retrieved memories' `metadata` using OR logic. Filters are defined using disjunctive normal form (OR of ANDs). For example: `filter_groups: [{filters: [{key: "author", value: {string_value: "agent 123"}, op: EQUAL}]}, {filters: [{key: "label", value: {string_value: "travel"}, op: EQUAL}, {key: "author", value: {string_value: "agent 321"}, op: EQUAL}]}]` would be equivalent to the logical expression: `(metadata.author = "agent 123" OR (metadata.label = "travel" AND metadata.author = "agent 321"))`. { # A conjunction of filters that will be combined using AND logic. - "filters": [ # Filters that will combined using AND logic. + "filters": [ # Represents filters that will be combined using AND logic. { # Filter to apply when retrieving memories. - "key": "A String", # Key of the filter. For example, "author" would apply to `metadata` entries with the key "author". - "negate": True or False, # If true, the filter will be negated. - "op": "A String", # Operator to apply to the filter. If not set, then EQUAL will be used. - "value": { # Memory metadata. # Value to compare to. - "boolValue": True or False, # Boolean value. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "key": "A String", # Represents the key of the filter. For example, "author" would apply to `metadata` entries with the key "author". + "negate": True or False, # Indicates whether the filter will be negated. + "op": "A String", # Represents the operator to apply to the filter. If not set, then EQUAL will be used. + "value": { # Memory metadata. # Represents the value to compare to. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, ], }, ], + "memoryTypes": [ # Optional. Specifies the types of memories to retrieve. If this field is empty or not provided, the request will default to retrieving only memories of type `NATURAL_LANGUAGE_COLLECTION`. If populated, the request will retrieve memories matching any of the specified `MemoryType` values. + "A String", + ], "scope": { # Required. The scope of the memories to retrieve. A memory must have exactly the same scope (`Memory.scope`) as the scope provided here to be retrieved (same keys and values). Order does not matter, but it is case-sensitive. "a_key": "A String", }, @@ -700,43 +880,85 @@

Method Details

{ # A retrieved memory. "distance": 3.14, # The distance between the query and the retrieved Memory. Smaller values indicate more similar memories. This is only set if similarity search was used for retrieval. "memory": { # A memory. # The retrieved Memory. - "createTime": "A String", # Output only. Timestamp when this Memory was created. - "description": "A String", # Optional. Description of the Memory. - "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", # 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. + "createTime": "A String", # Output only. Represents the timestamp when this Memory was created. + "description": "A String", # Optional. Represents the description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request. + "displayName": "A String", # Optional. Represents the display name of the Memory. + "expireTime": "A String", # Optional. Represents the 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", # Optional. Represents semantic knowledge extracted from the source content. + "memoryType": "A String", # Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided. + "metadata": { # Optional. Represents 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. - "doubleValue": 3.14, # Double value. - "stringValue": "A String", # String value. - "timestampValue": "A String", # Timestamp value. When filtering on timestamp values, only the seconds field will be compared. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. }, }, - "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` - "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. - "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request. "a_key": "A String", }, - "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. - "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. + "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL. + "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, - "topics": [ # Optional. The Topics of the Memory. + "structuredContent": { # Represents the structured value of the memory. # Optional. Represents the structured content of the memory. + "data": { # Required. Represents the structured value of the memory. + "a_key": "", # Properties of the object. + }, + "schemaId": "A String", # Required. Represents the schema ID for which this structured memory belongs to. + }, + "topics": [ # Optional. Represents the Topics of the Memory. { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. - "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. - "managedMemoryTopic": "A String", # Optional. The managed memory topic. + "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label. + "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic. }, ], - "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. - "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. + "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL. + "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated. }, }, ], }
+
+ retrieveProfiles(parent, body=None, x__xgafv=None) +
Retrieves profiles.
+
+Args:
+  parent: string, Required. The resource name of the ReasoningEngine to retrieve profiles from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.RetrieveProfiles.
+  "scope": { # Required. The scope of the profiles to retrieve.
+    "a_key": "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 MemoryBankService.RetrieveProfiles.
+  "profiles": { # The retrieved structured profiles, which match the schemas under the requested scope. The key is the ID of the schema that the profile is linked with, which corresponds to the `schema_id` defined inside the `SchemaConfig`, under `StructuredMemoryCustomizationConfig`.
+    "a_key": { # A memory profile.
+      "profile": { # Represents the profile data.
+        "a_key": "", # Properties of the object.
+      },
+      "schemaId": "A String", # Represents the ID of the schema. This ID corresponds to the `schema_id` defined inside the SchemaConfig, under StructuredMemoryCustomizationConfig.
+    },
+  },
+}
+
+
rollback(name, body=None, x__xgafv=None)
Rollback Memory to a specific revision.
diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.revisions.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.revisions.html
index 203b24c2b3..4a92ce2c06 100644
--- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.revisions.html
+++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.revisions.html
@@ -107,18 +107,25 @@ 

Method Details

An object of the form: { # A revision of a Memory. - "createTime": "A String", # Output only. Timestamp when this Memory Revision was created. - "expireTime": "A String", # Output only. Timestamp of when this resource is considered expired. - "extractedMemories": [ # Output only. The extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation. + "createTime": "A String", # Output only. Represents the timestamp when this Memory Revision was created. + "expireTime": "A String", # Output only. Represents the timestamp of when this resource is considered expired. + "extractedMemories": [ # Output only. Represents the extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation. { # An extracted memory that is the intermediate result before consolidation. - "fact": "A String", # Output only. The fact of the extracted memory. + "context": "A String", # Output only. Represents the explanation of why the information was extracted from the source content. + "fact": "A String", # Output only. Represents the fact of the extracted memory. + "structuredData": { # Output only. Represents the structured value of the extracted memory. + "a_key": "", # Properties of the object. + }, }, ], - "fact": "A String", # Output only. The fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation. - "labels": { # Output only. The labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`. + "fact": "A String", # Output only. Represents the fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation. + "labels": { # Output only. Represents the labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`. "a_key": "A String", }, - "name": "A String", # Identifier. The resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}` + "name": "A String", # Identifier. Represents the resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}` + "structuredData": { # Output only. Represents the structured value of the memory at the time of revision creation. + "a_key": "", # Properties of the object. + }, }
@@ -142,18 +149,25 @@

Method Details

{ # Response message for MemoryBankService.ListMemoryRevisions. "memoryRevisions": [ # The list of Memory Revisions in the request page. { # A revision of a Memory. - "createTime": "A String", # Output only. Timestamp when this Memory Revision was created. - "expireTime": "A String", # Output only. Timestamp of when this resource is considered expired. - "extractedMemories": [ # Output only. The extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation. + "createTime": "A String", # Output only. Represents the timestamp when this Memory Revision was created. + "expireTime": "A String", # Output only. Represents the timestamp of when this resource is considered expired. + "extractedMemories": [ # Output only. Represents the extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation. { # An extracted memory that is the intermediate result before consolidation. - "fact": "A String", # Output only. The fact of the extracted memory. + "context": "A String", # Output only. Represents the explanation of why the information was extracted from the source content. + "fact": "A String", # Output only. Represents the fact of the extracted memory. + "structuredData": { # Output only. Represents the structured value of the extracted memory. + "a_key": "", # Properties of the object. + }, }, ], - "fact": "A String", # Output only. The fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation. - "labels": { # Output only. The labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`. + "fact": "A String", # Output only. Represents the fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation. + "labels": { # Output only. Represents the labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`. "a_key": "A String", }, - "name": "A String", # Identifier. The resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}` + "name": "A String", # Identifier. Represents the resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}` + "structuredData": { # Output only. Represents the structured value of the memory at the time of revision creation. + "a_key": "", # Properties of the object. + }, }, ], "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. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.html new file mode 100644 index 0000000000..0b9ea1076b --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.html @@ -0,0 +1,149 @@ + + + +

Vertex AI API . reasoningEngines . runtimeRevisions . a2a

+

Instance Methods

+

+ message() +

+

Returns the message Resource.

+ +

+ tasks() +

+

Returns the tasks Resource.

+ +

+ v1() +

+

Returns the v1 Resource.

+ +

+ card(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

+ close()

+

Close httplib2 connections.

+

+ extendedAgentCard(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

Method Details

+
+ card(name, a2aEndpoint, historyLength=None, x__xgafv=None) +
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ extendedAgentCard(name, a2aEndpoint, historyLength=None, x__xgafv=None) +
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.message.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.message.html new file mode 100644 index 0000000000..deb04beb6f --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.message.html @@ -0,0 +1,140 @@ + + + +

Vertex AI API . reasoningEngines . runtimeRevisions . a2a . message

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ send(name, a2aEndpoint, body=None, x__xgafv=None)

+

Send post request for reasoning engine instance via the A2A post protocol apis.

+

+ stream(name, a2aEndpoint, body=None, x__xgafv=None)

+

Streams queries using a reasoning engine instance via the A2A streaming protocol apis.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ send(name, a2aEndpoint, body=None, x__xgafv=None) +
Send post request for reasoning engine instance via the A2A post protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send (required)
+  body: object, The request body.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ stream(name, a2aEndpoint, body=None, x__xgafv=None) +
Streams queries using a reasoning engine instance via the A2A streaming protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. e.g., v1/message:stream. (required)
+  body: object, The request body.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "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.reasoningEngines.runtimeRevisions.a2a.tasks.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.tasks.html new file mode 100644 index 0000000000..4f21c634ae --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.tasks.html @@ -0,0 +1,168 @@ + + + +

Vertex AI API . reasoningEngines . runtimeRevisions . a2a . tasks

+

Instance Methods

+

+ pushNotificationConfigs() +

+

Returns the pushNotificationConfigs Resource.

+ +

+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

+ cancel(name, a2aEndpoint, body=None, x__xgafv=None)

+

Send post request for reasoning engine instance via the A2A post protocol apis.

+

+ close()

+

Close httplib2 connections.

+

+ subscribe(name, a2aEndpoint, x__xgafv=None)

+

Stream get request for reasoning engine instance via the A2A stream get protocol apis.

+

Method Details

+
+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None) +
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ cancel(name, a2aEndpoint, body=None, x__xgafv=None) +
Send post request for reasoning engine instance via the A2A post protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send (required)
+  body: object, The request body.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ subscribe(name, a2aEndpoint, x__xgafv=None) +
Stream get request for reasoning engine instance via the A2A stream get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "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.reasoningEngines.runtimeRevisions.a2a.tasks.pushNotificationConfigs.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.tasks.pushNotificationConfigs.html new file mode 100644 index 0000000000..f69eb31a4a --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.tasks.pushNotificationConfigs.html @@ -0,0 +1,110 @@ + + + +

Vertex AI API . reasoningEngines . runtimeRevisions . a2a . tasks . pushNotificationConfigs

+

Instance Methods

+

+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None) +
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.v1.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.v1.html new file mode 100644 index 0000000000..cc48a30ae2 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.v1.html @@ -0,0 +1,144 @@ + + + +

Vertex AI API . reasoningEngines . runtimeRevisions . a2a . v1

+

Instance Methods

+

+ message() +

+

Returns the message Resource.

+ +

+ tasks() +

+

Returns the tasks Resource.

+ +

+ card(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

+ close()

+

Close httplib2 connections.

+

+ extendedAgentCard(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

Method Details

+
+ card(name, a2aEndpoint, historyLength=None, x__xgafv=None) +
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ extendedAgentCard(name, a2aEndpoint, historyLength=None, x__xgafv=None) +
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.v1.message.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.v1.message.html new file mode 100644 index 0000000000..d7b260e4a5 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.v1.message.html @@ -0,0 +1,140 @@ + + + +

Vertex AI API . reasoningEngines . runtimeRevisions . a2a . v1 . message

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ send(name, a2aEndpoint, body=None, x__xgafv=None)

+

Send post request for reasoning engine instance via the A2A post protocol apis.

+

+ stream(name, a2aEndpoint, body=None, x__xgafv=None)

+

Streams queries using a reasoning engine instance via the A2A streaming protocol apis.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ send(name, a2aEndpoint, body=None, x__xgafv=None) +
Send post request for reasoning engine instance via the A2A post protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send (required)
+  body: object, The request body.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ stream(name, a2aEndpoint, body=None, x__xgafv=None) +
Streams queries using a reasoning engine instance via the A2A streaming protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. e.g., v1/message:stream. (required)
+  body: object, The request body.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "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.reasoningEngines.runtimeRevisions.a2a.v1.tasks.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.v1.tasks.html new file mode 100644 index 0000000000..bf0601341c --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.v1.tasks.html @@ -0,0 +1,168 @@ + + + +

Vertex AI API . reasoningEngines . runtimeRevisions . a2a . v1 . tasks

+

Instance Methods

+

+ pushNotificationConfigs() +

+

Returns the pushNotificationConfigs Resource.

+ +

+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

+ cancel(name, a2aEndpoint, body=None, x__xgafv=None)

+

Send post request for reasoning engine instance via the A2A post protocol apis.

+

+ close()

+

Close httplib2 connections.

+

+ subscribe(name, a2aEndpoint, x__xgafv=None)

+

Stream get request for reasoning engine instance via the A2A stream get protocol apis.

+

Method Details

+
+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None) +
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ cancel(name, a2aEndpoint, body=None, x__xgafv=None) +
Send post request for reasoning engine instance via the A2A post protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send (required)
+  body: object, The request body.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ subscribe(name, a2aEndpoint, x__xgafv=None) +
Stream get request for reasoning engine instance via the A2A stream get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "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.reasoningEngines.runtimeRevisions.a2a.v1.tasks.pushNotificationConfigs.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.v1.tasks.pushNotificationConfigs.html new file mode 100644 index 0000000000..fb2d418dd3 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.a2a.v1.tasks.pushNotificationConfigs.html @@ -0,0 +1,110 @@ + + + +

Vertex AI API . reasoningEngines . runtimeRevisions . a2a . v1 . tasks . pushNotificationConfigs

+

Instance Methods

+

+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None) +
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.html index 2d404847da..4798ecc24e 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.runtimeRevisions.html @@ -74,6 +74,11 @@

Vertex AI API . reasoningEngines . runtimeRevisions

Instance Methods

+

+ a2a() +

+

Returns the a2a Resource.

+

operations()

@@ -82,10 +87,80 @@

Instance Methods

close()

Close httplib2 connections.

+

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

+

Queries using a reasoning engine.

+

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

+

Streams queries using a reasoning engine.

Method Details

close()
Close httplib2 connections.
+
+ query(name, body=None, x__xgafv=None) +
Queries using a reasoning engine.
+
+Args:
+  name: string, Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ReasoningEngineExecutionService.Query.
+  "classMethod": "A String", # Optional. Class method to be used for the query. It is optional and defaults to "query" if unspecified.
+  "input": { # Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+  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 ReasoningEngineExecutionService.Query
+  "output": "", # Response provided by users in JSON object format.
+}
+
+ +
+ streamQuery(name, body=None, x__xgafv=None) +
Streams queries using a reasoning engine.
+
+Args:
+  name: string, Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ReasoningEngineExecutionService.StreamQuery.
+  "classMethod": "A String", # Optional. Class method to be used for the stream query. It is optional and defaults to "stream_query" if unspecified.
+  "input": { # Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "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.reasoningEngines.sandboxEnvironmentSnapshots.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentSnapshots.html new file mode 100644 index 0000000000..b436df5e22 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentSnapshots.html @@ -0,0 +1,218 @@ + + + +

Vertex AI API . reasoningEngines . sandboxEnvironmentSnapshots

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes the specific SandboxEnvironmentSnapshot.

+

+ get(name, x__xgafv=None)

+

Gets details of the specific SandboxEnvironmentSnapshot.

+

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

+

Lists SandboxEnvironmentSnapshots in a given reasoning engine.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes the specific SandboxEnvironmentSnapshot.
+
+Args:
+  name: string, Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}` (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 the specific SandboxEnvironmentSnapshot.
+
+Args:
+  name: string, Required. The resource name of the sandbox environment snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # SandboxEnvironmentSnapshot is a snapshot of the SandboxEnvironment.
+  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentSnapshot was created.
+  "displayName": "A String", # Required. The display name of the SandboxEnvironmentSnapshot.
+  "expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironmentSnapshot is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+  "name": "A String", # Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
+  "owner": "A String", # Optional. Owner information for this sandbox snapshot. Different owners will have isolations on snapshot storage and identity. If not set, snapshot will be created as the default owner.
+  "parentSnapshot": "A String", # Output only. The resource name of the parent SandboxEnvironmentSnapshot. Empty if this is a root Snapshot (the first snapshot from a newly created sandbox). Can be used to reconstruct the whole ancestry tree of snapshots.
+  "postSnapshotAction": "A String", # Optional. Input only. Action to take on the source SandboxEnvironment after the snapshot is taken. This field is only used in CreateSandboxEnvironmentSnapshotRequest and it is not stored in the resource.
+  "sizeBytes": "A String", # Optional. Output only. Size of the snapshot data in bytes.
+  "sourceSandboxEnvironment": "A String", # Required. The resource name of the source SandboxEnvironment this snapshot was taken from.
+  "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently updated.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists SandboxEnvironmentSnapshots in a given reasoning engine.
+
+Args:
+  parent: string, Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
+  pageSize: integer, Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100.
+  pageToken: string, Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page.
+  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 SandboxEnvironmentService.ListSandboxEnvironmentSnapshots.
+  "nextPageToken": "A String", # A token, which can be sent as ListSandboxEnvironmentSnapshotsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.
+  "sandboxEnvironmentSnapshots": [ # The SandboxEnvironmentSnapshots matching the request.
+    { # SandboxEnvironmentSnapshot is a snapshot of the SandboxEnvironment.
+      "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentSnapshot was created.
+      "displayName": "A String", # Required. The display name of the SandboxEnvironmentSnapshot.
+      "expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironmentSnapshot is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+      "name": "A String", # Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
+      "owner": "A String", # Optional. Owner information for this sandbox snapshot. Different owners will have isolations on snapshot storage and identity. If not set, snapshot will be created as the default owner.
+      "parentSnapshot": "A String", # Output only. The resource name of the parent SandboxEnvironmentSnapshot. Empty if this is a root Snapshot (the first snapshot from a newly created sandbox). Can be used to reconstruct the whole ancestry tree of snapshots.
+      "postSnapshotAction": "A String", # Optional. Input only. Action to take on the source SandboxEnvironment after the snapshot is taken. This field is only used in CreateSandboxEnvironmentSnapshotRequest and it is not stored in the resource.
+      "sizeBytes": "A String", # Optional. Output only. Size of the snapshot data in bytes.
+      "sourceSandboxEnvironment": "A String", # Required. The resource name of the source SandboxEnvironment this snapshot was taken from.
+      "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.
+      "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently 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.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentSnapshots.operations.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentSnapshots.operations.html new file mode 100644 index 0000000000..63bf4fe057 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentSnapshots.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . reasoningEngines . sandboxEnvironmentSnapshots . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

+

+ 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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ 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.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # 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.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
+    "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.
+        
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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.reasoningEngines.sandboxEnvironmentTemplates.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.html new file mode 100644 index 0000000000..c93748603e --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.html @@ -0,0 +1,330 @@ + + + +

Vertex AI API . reasoningEngines . sandboxEnvironmentTemplates

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates a SandboxEnvironmentTemplate in a given reasoning engine.

+

+ delete(name, x__xgafv=None)

+

Deletes the specific SandboxEnvironmentTemplate.

+

+ get(name, x__xgafv=None)

+

Gets details of the specific SandboxEnvironmentTemplate.

+

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

+

Lists SandboxEnvironmentTemplates in a given reasoning engine.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a SandboxEnvironmentTemplate in a given reasoning engine.
+
+Args:
+  parent: string, Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The specification of a SandboxEnvironmentTemplate. A SandboxEnvironmentTemplate defines a template for creating SandboxEnvironments.
+  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was created.
+  "customContainerEnvironment": { # The customized sandbox runtime environment for BYOC. # The sandbox environment for custom container workloads.
+    "customContainerSpec": { # Specification for deploying from a custom container image. # The specification of the custom container environment.
+      "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.
+    },
+    "ports": [ # Ports to expose from the container.
+      { # Represents a network port in a container.
+        "port": 42, # Optional. Port number to expose. This must be a valid port number, between 1 and 65535.
+        "protocol": "A String", # Optional. Protocol for port. Defaults to TCP if not specified.
+      },
+    ],
+    "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Resource requests and limits for the container.
+      "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi").
+        "a_key": "A String",
+      },
+      "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi").
+        "a_key": "A String",
+      },
+    },
+  },
+  "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads.
+    "defaultContainerCategory": "A String", # Required. The category of the default container image.
+  },
+  "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+  "name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
+  "state": "A String", # Output only. The state of the sandbox environment template.
+  "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
+  "warmPoolConfig": { # Configuration for a warm pool of sandbox instances. # Optional. The configuration for the warm pool of this template.
+    "targetInstanceCount": 42, # Optional. The target number of pre-warmed instances to maintain.
+  },
+}
+
+  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 the specific SandboxEnvironmentTemplate.
+
+Args:
+  name: string, Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` (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 the specific SandboxEnvironmentTemplate.
+
+Args:
+  name: string, Required. The resource name of the sandbox environment template. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The specification of a SandboxEnvironmentTemplate. A SandboxEnvironmentTemplate defines a template for creating SandboxEnvironments.
+  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was created.
+  "customContainerEnvironment": { # The customized sandbox runtime environment for BYOC. # The sandbox environment for custom container workloads.
+    "customContainerSpec": { # Specification for deploying from a custom container image. # The specification of the custom container environment.
+      "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.
+    },
+    "ports": [ # Ports to expose from the container.
+      { # Represents a network port in a container.
+        "port": 42, # Optional. Port number to expose. This must be a valid port number, between 1 and 65535.
+        "protocol": "A String", # Optional. Protocol for port. Defaults to TCP if not specified.
+      },
+    ],
+    "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Resource requests and limits for the container.
+      "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi").
+        "a_key": "A String",
+      },
+      "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi").
+        "a_key": "A String",
+      },
+    },
+  },
+  "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads.
+    "defaultContainerCategory": "A String", # Required. The category of the default container image.
+  },
+  "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+  "name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
+  "state": "A String", # Output only. The state of the sandbox environment template.
+  "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
+  "warmPoolConfig": { # Configuration for a warm pool of sandbox instances. # Optional. The configuration for the warm pool of this template.
+    "targetInstanceCount": 42, # Optional. The target number of pre-warmed instances to maintain.
+  },
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists SandboxEnvironmentTemplates in a given reasoning engine.
+
+Args:
+  parent: string, Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
+  pageSize: integer, Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned.
+  pageToken: string, Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page.
+  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 SandboxEnvironmentService.ListSandboxEnvironmentTemplates.
+  "nextPageToken": "A String", # A token, which can be sent as ListSandboxEnvironmentTemplatesRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.
+  "sandboxEnvironmentTemplates": [ # The SandboxEnvironmentTemplates matching the request.
+    { # The specification of a SandboxEnvironmentTemplate. A SandboxEnvironmentTemplate defines a template for creating SandboxEnvironments.
+      "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was created.
+      "customContainerEnvironment": { # The customized sandbox runtime environment for BYOC. # The sandbox environment for custom container workloads.
+        "customContainerSpec": { # Specification for deploying from a custom container image. # The specification of the custom container environment.
+          "imageUri": "A String", # Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.
+        },
+        "ports": [ # Ports to expose from the container.
+          { # Represents a network port in a container.
+            "port": 42, # Optional. Port number to expose. This must be a valid port number, between 1 and 65535.
+            "protocol": "A String", # Optional. Protocol for port. Defaults to TCP if not specified.
+          },
+        ],
+        "resources": { # Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template. # Resource requests and limits for the container.
+          "limits": { # Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "500m", "1Gi").
+            "a_key": "A String",
+          },
+          "requests": { # Optional. The requested amounts of compute resources. Keys are resource names (e.g., "cpu", "memory"). Values are quantities (e.g., "250m", "512Mi").
+            "a_key": "A String",
+          },
+        },
+      },
+      "defaultContainerEnvironment": { # The default sandbox runtime environment for default container workloads. # The sandbox environment for default container workloads.
+        "defaultContainerCategory": "A String", # Required. The category of the default container image.
+      },
+      "displayName": "A String", # Required. The display name of the SandboxEnvironmentTemplate.
+      "name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
+      "state": "A String", # Output only. The state of the sandbox environment template.
+      "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.
+      "warmPoolConfig": { # Configuration for a warm pool of sandbox instances. # Optional. The configuration for the warm pool of this template.
+        "targetInstanceCount": 42, # Optional. The target number of pre-warmed instances to maintain.
+      },
+    },
+  ],
+}
+
+ +
+ 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/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.operations.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.operations.html new file mode 100644 index 0000000000..fdf891b862 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . reasoningEngines . sandboxEnvironmentTemplates . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

+

+ 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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ 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.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # 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.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
+    "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.
+        
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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.reasoningEngines.sandboxEnvironments.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironments.html index 387dfd57d0..5b1af0d592 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironments.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironments.html @@ -100,6 +100,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

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

+

Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.

Method Details

close() @@ -119,6 +122,7 @@

Method Details

"connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment. "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer. "loadBalancerIp": "A String", # Output only. The IP address of the load balancer. + "sandboxHostname": "A String", # Output only. The hostname of the SandboxEnvironment. "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment. }, "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created. @@ -266,6 +270,7 @@

Method Details

"connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment. "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer. "loadBalancerIp": "A String", # Output only. The IP address of the load balancer. + "sandboxHostname": "A String", # Output only. The hostname of the SandboxEnvironment. "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment. }, "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created. @@ -310,6 +315,7 @@

Method Details

"connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment. "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer. "loadBalancerIp": "A String", # Output only. The IP address of the load balancer. + "sandboxHostname": "A String", # Output only. The hostname of the SandboxEnvironment. "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment. }, "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created. @@ -346,4 +352,56 @@

Method Details

+
+ snapshot(name, body=None, x__xgafv=None) +
Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.
+
+Args:
+  name: string, Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # SandboxEnvironmentSnapshot is a snapshot of the SandboxEnvironment.
+  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironmentSnapshot was created.
+  "displayName": "A String", # Required. The display name of the SandboxEnvironmentSnapshot.
+  "expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironmentSnapshot is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+  "name": "A String", # Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`
+  "owner": "A String", # Optional. Owner information for this sandbox snapshot. Different owners will have isolations on snapshot storage and identity. If not set, snapshot will be created as the default owner.
+  "parentSnapshot": "A String", # Output only. The resource name of the parent SandboxEnvironmentSnapshot. Empty if this is a root Snapshot (the first snapshot from a newly created sandbox). Can be used to reconstruct the whole ancestry tree of snapshots.
+  "postSnapshotAction": "A String", # Optional. Input only. Action to take on the source SandboxEnvironment after the snapshot is taken. This field is only used in CreateSandboxEnvironmentSnapshotRequest and it is not stored in the resource.
+  "sizeBytes": "A String", # Optional. Output only. Size of the snapshot data in bytes.
+  "sourceSandboxEnvironment": "A String", # Required. The resource name of the source SandboxEnvironment this snapshot was taken from.
+  "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently 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.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html index 7dfa3d180f..dd824581fe 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html @@ -242,6 +242,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/aiplatform_v1beta1.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html index 4b665b9265..496856071b 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html @@ -250,6 +250,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/aiplatform_v1beta1.v1beta1.html b/docs/dyn/aiplatform_v1beta1.v1beta1.html index 2ba14b5d43..080d449292 100644 --- a/docs/dyn/aiplatform_v1beta1.v1beta1.html +++ b/docs/dyn/aiplatform_v1beta1.v1beta1.html @@ -384,6 +384,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -3189,6 +3194,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` @@ -3514,6 +3524,11 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result. + "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response. + "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation + }, + }, "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}` diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index 7ca58d2ca4..46a9180e05 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -22688,7 +22688,7 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", +"description": "Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", "required": true, @@ -23182,119 +23182,123 @@ } } }, -"sandboxEnvironments": { +"runtimeRevisions": { "methods": { -"create": { -"description": "Creates a SandboxEnvironment in a given reasoning engine.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", +"query": { +"description": "Queries using a reasoning engine.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:query", "httpMethod": "POST", -"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.create", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.query", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.", +"name": { +"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/sandboxEnvironments", +"path": "v1/{+name}:query", "request": { -"$ref": "GoogleCloudAiplatformV1SandboxEnvironment" +"$ref": "GoogleCloudAiplatformV1QueryReasoningEngineRequest" }, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1QueryReasoningEngineResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"delete": { -"description": "Deletes the specific SandboxEnvironment.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", -"httpMethod": "DELETE", -"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.delete", +"streamQuery": { +"description": "Streams queries using a reasoning engine.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:streamQuery", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.streamQuery", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", +"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}", +"path": "v1/{+name}:streamQuery", +"request": { +"$ref": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest" +}, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleApiHttpBody" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} }, -"execute": { -"description": "Executes using a sandbox environment.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:execute", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.execute", +"sandboxEnvironmentSnapshots": { +"methods": { +"delete": { +"description": "Deletes the specific SandboxEnvironmentSnapshot.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", +"description": "Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:execute", -"request": { -"$ref": "GoogleCloudAiplatformV1ExecuteSandboxEnvironmentRequest" -}, +"path": "v1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1ExecuteSandboxEnvironmentResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets details of the specific SandboxEnvironment.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", +"description": "Gets details of the specific SandboxEnvironmentSnapshot.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.get", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The resource name of the sandbox environment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", +"description": "Required. The resource name of the sandbox environment snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1SandboxEnvironment" +"$ref": "GoogleCloudAiplatformV1SandboxEnvironmentSnapshot" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists SandboxEnvironments in a given reasoning engine.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", +"description": "Lists SandboxEnvironmentSnapshots in a given reasoning engine.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots", "httpMethod": "GET", -"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.list", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.list", "parameterOrder": [ "parent" ], @@ -23305,13 +23309,13 @@ "type": "string" }, "pageSize": { -"description": "Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.", +"description": "Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page.", +"description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, @@ -23323,9 +23327,9 @@ "type": "string" } }, -"path": "v1/{+parent}/sandboxEnvironments", +"path": "v1/{+parent}/sandboxEnvironmentSnapshots", "response": { -"$ref": "GoogleCloudAiplatformV1ListSandboxEnvironmentsResponse" +"$ref": "GoogleCloudAiplatformV1ListSandboxEnvironmentSnapshotsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -23337,9 +23341,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:cancel", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.cancel", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.cancel", "parameterOrder": [ "name" ], @@ -23347,7 +23351,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -23362,9 +23366,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.delete", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.delete", "parameterOrder": [ "name" ], @@ -23372,7 +23376,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -23387,9 +23391,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.get", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.get", "parameterOrder": [ "name" ], @@ -23397,7 +23401,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -23412,9 +23416,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:wait", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.wait", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.wait", "parameterOrder": [ "name" ], @@ -23422,7 +23426,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -23445,61 +23449,28 @@ } } }, -"sessions": { +"sandboxEnvironmentTemplates": { "methods": { -"appendEvent": { -"description": "Appends an event to a given session.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.appendEvent", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}:appendEvent", -"request": { -"$ref": "GoogleCloudAiplatformV1SessionEvent" -}, -"response": { -"$ref": "GoogleCloudAiplatformV1AppendEventResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "create": { -"description": "Creates a new Session.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", +"description": "Creates a SandboxEnvironmentTemplate in a given reasoning engine.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates", "httpMethod": "POST", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.create", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"description": "Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" -}, -"sessionId": { -"description": "Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first and last characters must be a letter or number.", -"location": "query", -"type": "string" } }, -"path": "v1/{+parent}/sessions", +"path": "v1/{+parent}/sandboxEnvironmentTemplates", "request": { -"$ref": "GoogleCloudAiplatformV1Session" +"$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplate" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -23509,18 +23480,18 @@ ] }, "delete": { -"description": "Deletes details of the specific Session.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", +"description": "Deletes the specific SandboxEnvironmentTemplate.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.delete", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", +"description": "Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$", "required": true, "type": "string" } @@ -23534,105 +23505,66 @@ ] }, "get": { -"description": "Gets details of the specific Session.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", +"description": "Gets details of the specific SandboxEnvironmentTemplate.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.get", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", +"description": "Required. The resource name of the sandbox environment template. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1Session" +"$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplate" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists Sessions in a given reasoning engine.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", +"description": "Lists SandboxEnvironmentTemplates in a given reasoning engine.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates", "httpMethod": "GET", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.list", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { -"description": "Optional. The standard list filter. Supported fields: * `display_name` * `user_id` * `labels` Example: `display_name=\"abc\"`, `user_id=\"123\"`, `labels.key=\"value\"`.", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "pageSize": { -"description": "Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.", +"description": "Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.", +"description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"description": "Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/sessions", -"response": { -"$ref": "GoogleCloudAiplatformV1ListSessionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"patch": { -"description": "Updates the specific Session.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", -"httpMethod": "PATCH", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", -"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": "v1/{+name}", -"request": { -"$ref": "GoogleCloudAiplatformV1Session" -}, +"path": "v1/{+parent}/sandboxEnvironmentTemplates", "response": { -"$ref": "GoogleCloudAiplatformV1Session" +"$ref": "GoogleCloudAiplatformV1ListSandboxEnvironmentTemplatesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -23640,63 +23572,13 @@ } }, "resources": { -"events": { -"methods": { -"list": { -"description": "Lists Events in a given session.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.events.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp>=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/events", -"response": { -"$ref": "GoogleCloudAiplatformV1ListEventsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:cancel", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.cancel", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.cancel", "parameterOrder": [ "name" ], @@ -23704,7 +23586,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -23719,9 +23601,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.delete", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.delete", "parameterOrder": [ "name" ], @@ -23729,7 +23611,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -23744,9 +23626,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.get", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.get", "parameterOrder": [ "name" ], @@ -23754,7 +23636,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -23767,65 +23649,19 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.list", +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.wait", "parameterOrder": [ "name" ], "parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", -"type": "string" -}, "name": { -"description": "The name of the operation's parent resource.", +"description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", -"required": true, -"type": "string" -}, -"pageSize": { -"description": "The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The standard list page token.", -"location": "query", -"type": "string" -}, -"returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1/{+name}/operations", -"response": { -"$ref": "GoogleLongrunningListOperationsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:wait", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.wait", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to wait on.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -23847,52 +23683,50 @@ } } } -} -} }, -"schedules": { +"sandboxEnvironments": { "methods": { "create": { -"description": "Creates a Schedule.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules", +"description": "Creates a SandboxEnvironment in a given reasoning engine.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", "httpMethod": "POST", -"id": "aiplatform.projects.locations.schedules.create", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The resource name of the Location to create the Schedule in. Format: `projects/{project}/locations/{location}`", +"description": "Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/schedules", +"path": "v1/{+parent}/sandboxEnvironments", "request": { -"$ref": "GoogleCloudAiplatformV1Schedule" +"$ref": "GoogleCloudAiplatformV1SandboxEnvironment" }, "response": { -"$ref": "GoogleCloudAiplatformV1Schedule" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a Schedule.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", +"description": "Deletes the specific SandboxEnvironment.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.schedules.delete", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the Schedule resource to be deleted. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", +"description": "Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "required": true, "type": "string" } @@ -23905,162 +23739,123 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"get": { -"description": "Gets a Schedule.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.schedules.get", +"execute": { +"description": "Executes using a sandbox environment.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:execute", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.execute", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the Schedule resource. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", +"description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}", +"path": "v1/{+name}:execute", +"request": { +"$ref": "GoogleCloudAiplatformV1ExecuteSandboxEnvironmentRequest" +}, "response": { -"$ref": "GoogleCloudAiplatformV1Schedule" +"$ref": "GoogleCloudAiplatformV1ExecuteSandboxEnvironmentResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"list": { -"description": "Lists Schedules in a Location.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules", +"get": { +"description": "Gets details of the specific SandboxEnvironment.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.schedules.list", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.get", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"filter": { -"description": "Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state=\"ACTIVE\" AND display_name:\"my_schedule_*\"` * `NOT display_name=\"my_schedule\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `end_time>\"2021-05-18T00:00:00Z\" OR NOT end_time:*` * `create_pipeline_job_request:*`", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "A comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple order_by fields provided. For example, using \"create_time desc, end_time\" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time`", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "The standard list page size. Default to 100 if not specified.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the Location to list the Schedules from. Format: `projects/{project}/locations/{location}`", +"name": { +"description": "Required. The resource name of the sandbox environment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/schedules", +"path": "v1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1ListSchedulesResponse" +"$ref": "GoogleCloudAiplatformV1SandboxEnvironment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"patch": { -"description": "Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", -"httpMethod": "PATCH", -"id": "aiplatform.projects.locations.schedules.patch", +"list": { +"description": "Lists SandboxEnvironments in a given reasoning engine.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "Immutable. The resource name of the Schedule.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", -"required": true, -"type": "string" -}, -"updateMask": { -"description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", -"format": "google-fieldmask", +"filter": { +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" -} -}, -"path": "v1/{+name}", -"request": { -"$ref": "GoogleCloudAiplatformV1Schedule" }, -"response": { -"$ref": "GoogleCloudAiplatformV1Schedule" +"pageSize": { +"description": "Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.", +"format": "int32", +"location": "query", +"type": "integer" }, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] +"pageToken": { +"description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" }, -"pause": { -"description": "Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.schedules.pause", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the Schedule resource to be paused. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", +"parent": { +"description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:pause", -"request": { -"$ref": "GoogleCloudAiplatformV1PauseScheduleRequest" -}, +"path": "v1/{+parent}/sandboxEnvironments", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleCloudAiplatformV1ListSandboxEnvironmentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"resume": { -"description": "Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume", +"snapshot": { +"description": "Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:snapshot", "httpMethod": "POST", -"id": "aiplatform.projects.locations.schedules.resume", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.snapshot", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the Schedule resource to be resumed. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", +"description": "Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:resume", +"path": "v1/{+name}:snapshot", "request": { -"$ref": "GoogleCloudAiplatformV1ResumeScheduleRequest" +"$ref": "GoogleCloudAiplatformV1SandboxEnvironmentSnapshot" }, "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -24072,9 +23867,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.schedules.operations.cancel", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.cancel", "parameterOrder": [ "name" ], @@ -24082,7 +23877,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -24097,9 +23892,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.schedules.operations.delete", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.delete", "parameterOrder": [ "name" ], @@ -24107,7 +23902,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -24122,9 +23917,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.schedules.operations.get", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.get", "parameterOrder": [ "name" ], @@ -24132,7 +23927,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -24145,109 +23940,96 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.schedules.operations.list", +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.wait", "parameterOrder": [ "name" ], "parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", -"type": "string" -}, "name": { -"description": "The name of the operation's parent resource.", +"description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, -"pageSize": { -"description": "The standard list page size.", -"format": "int32", +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", "location": "query", -"type": "integer" +"type": "string" +} }, -"pageToken": { -"description": "The standard list page token.", -"location": "query", -"type": "string" -}, -"returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1/{+name}/operations", +"path": "v1/{+name}:wait", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} +} +} }, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait", +"sessions": { +"methods": { +"appendEvent": { +"description": "Appends an event to a given session.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent", "httpMethod": "POST", -"id": "aiplatform.projects.locations.schedules.operations.wait", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.appendEvent", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to wait on.", +"description": "Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "required": true, "type": "string" -}, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", -"location": "query", -"type": "string" } }, -"path": "v1/{+name}:wait", +"path": "v1/{+name}:appendEvent", +"request": { +"$ref": "GoogleCloudAiplatformV1SessionEvent" +}, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1AppendEventResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} }, -"specialistPools": { -"methods": { "create": { -"description": "Creates a SpecialistPool.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools", +"description": "Creates a new Session.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", "httpMethod": "POST", -"id": "aiplatform.projects.locations.specialistPools.create", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The parent Project name for the new SpecialistPool. The form is `projects/{project}/locations/{location}`.", +"description": "Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" +}, +"sessionId": { +"description": "Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first and last characters must be a letter or number.", +"location": "query", +"type": "string" } }, -"path": "v1/{+parent}/specialistPools", +"path": "v1/{+parent}/sessions", "request": { -"$ref": "GoogleCloudAiplatformV1SpecialistPool" +"$ref": "GoogleCloudAiplatformV1Session" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -24257,23 +24039,18 @@ ] }, "delete": { -"description": "Deletes a SpecialistPool as well as all Specialists in the pool.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", +"description": "Deletes details of the specific Session.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.specialistPools.delete", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.delete", "parameterOrder": [ "name" ], "parameters": { -"force": { -"description": "If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.)", -"location": "query", -"type": "boolean" -}, "name": { -"description": "Required. The resource name of the SpecialistPool to delete. Format: `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`", +"description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } @@ -24287,90 +24064,94 @@ ] }, "get": { -"description": "Gets a SpecialistPool.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", +"description": "Gets details of the specific Session.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.specialistPools.get", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.", +"description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1SpecialistPool" +"$ref": "GoogleCloudAiplatformV1Session" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists SpecialistPools in a Location.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools", +"description": "Lists Sessions in a given reasoning engine.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", "httpMethod": "GET", -"id": "aiplatform.projects.locations.specialistPools.list", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.list", "parameterOrder": [ "parent" ], "parameters": { +"filter": { +"description": "Optional. The standard list filter. Supported fields: * `display_name` * `user_id` * `labels` Example: `display_name=\"abc\"`, `user_id=\"123\"`, `labels.key=\"value\"`.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", +"location": "query", +"type": "string" +}, "pageSize": { -"description": "The standard list page size.", +"description": "Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty.", +"description": "Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The name of the SpecialistPool's parent resource. Format: `projects/{project}/locations/{location}`", +"description": "Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" -}, -"readMask": { -"description": "Mask specifying which fields to read. FieldMask represents a set of", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, -"path": "v1/{+parent}/specialistPools", +"path": "v1/{+parent}/sessions", "response": { -"$ref": "GoogleCloudAiplatformV1ListSpecialistPoolsResponse" +"$ref": "GoogleCloudAiplatformV1ListSessionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { -"description": "Updates a SpecialistPool.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", +"description": "Updates the specific Session.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", "httpMethod": "PATCH", -"id": "aiplatform.projects.locations.specialistPools.patch", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The resource name of the SpecialistPool.", +"description": "Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "Required. The update mask applies to the resource.", +"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" @@ -24378,10 +24159,10 @@ }, "path": "v1/{+name}", "request": { -"$ref": "GoogleCloudAiplatformV1SpecialistPool" +"$ref": "GoogleCloudAiplatformV1Session" }, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1Session" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -24389,13 +24170,63 @@ } }, "resources": { +"events": { +"methods": { +"list": { +"description": "Lists Events in a given session.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.events.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp>=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/events", +"response": { +"$ref": "GoogleCloudAiplatformV1ListEventsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.specialistPools.operations.cancel", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.cancel", "parameterOrder": [ "name" ], @@ -24403,7 +24234,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -24418,9 +24249,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.specialistPools.operations.delete", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.delete", "parameterOrder": [ "name" ], @@ -24428,7 +24259,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -24443,9 +24274,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.specialistPools.operations.get", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.get", "parameterOrder": [ "name" ], @@ -24453,7 +24284,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -24468,9 +24299,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.specialistPools.operations.list", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.list", "parameterOrder": [ "name" ], @@ -24483,7 +24314,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "required": true, "type": "string" }, @@ -24514,9 +24345,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.projects.locations.specialistPools.operations.wait", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.wait", "parameterOrder": [ "name" ], @@ -24524,7 +24355,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -24546,146 +24377,220 @@ } } } +} +} }, -"studies": { +"schedules": { "methods": { "create": { -"description": "Creates a Study. A resource name will be generated after creation of the Study.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies", +"description": "Creates a Schedule.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules", "httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.create", +"id": "aiplatform.projects.locations.schedules.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`", +"description": "Required. The resource name of the Location to create the Schedule in. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/studies", +"path": "v1/{+parent}/schedules", "request": { -"$ref": "GoogleCloudAiplatformV1Study" +"$ref": "GoogleCloudAiplatformV1Schedule" }, "response": { -"$ref": "GoogleCloudAiplatformV1Study" +"$ref": "GoogleCloudAiplatformV1Schedule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a Study.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", +"description": "Deletes a Schedule.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.studies.delete", +"id": "aiplatform.projects.locations.schedules.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the Study resource to be deleted. Format: `projects/{project}/locations/{location}/studies/{study}`", +"description": "Required. The name of the Schedule resource to be deleted. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets a Study by name.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", +"description": "Gets a Schedule.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.studies.get", +"id": "aiplatform.projects.locations.schedules.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the Study resource. Format: `projects/{project}/locations/{location}/studies/{study}`", +"description": "Required. The name of the Schedule resource. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1Study" +"$ref": "GoogleCloudAiplatformV1Schedule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists all the studies in a region for an associated project.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies", +"description": "Lists Schedules in a Location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules", "httpMethod": "GET", -"id": "aiplatform.projects.locations.studies.list", +"id": "aiplatform.projects.locations.schedules.list", "parameterOrder": [ "parent" ], "parameters": { +"filter": { +"description": "Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state=\"ACTIVE\" AND display_name:\"my_schedule_*\"` * `NOT display_name=\"my_schedule\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `end_time>\"2021-05-18T00:00:00Z\" OR NOT end_time:*` * `create_pipeline_job_request:*`", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "A comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple order_by fields provided. For example, using \"create_time desc, end_time\" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time`", +"location": "query", +"type": "string" +}, "pageSize": { -"description": "Optional. The maximum number of studies to return per \"page\" of results. If unspecified, service will pick an appropriate default.", +"description": "The standard list page size. Default to 100 if not specified.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", +"description": "The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource name of the Location to list the Study from. Format: `projects/{project}/locations/{location}`", +"description": "Required. The resource name of the Location to list the Schedules from. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/studies", +"path": "v1/{+parent}/schedules", "response": { -"$ref": "GoogleCloudAiplatformV1ListStudiesResponse" +"$ref": "GoogleCloudAiplatformV1ListSchedulesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"lookup": { -"description": "Looks a study up using the user-defined display_name field instead of the fully qualified resource name.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies:lookup", +"patch": { +"description": "Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.schedules.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The resource name of the Schedule.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1Schedule" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1Schedule" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"pause": { +"description": "Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause", "httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.lookup", +"id": "aiplatform.projects.locations.schedules.pause", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The resource name of the Location to get the Study from. Format: `projects/{project}/locations/{location}`", +"name": { +"description": "Required. The name of the Schedule resource to be paused. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/studies:lookup", +"path": "v1/{+name}:pause", "request": { -"$ref": "GoogleCloudAiplatformV1LookupStudyRequest" +"$ref": "GoogleCloudAiplatformV1PauseScheduleRequest" }, "response": { -"$ref": "GoogleCloudAiplatformV1Study" +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"resume": { +"description": "Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.schedules.resume", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Schedule resource to be resumed. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:resume", +"request": { +"$ref": "GoogleCloudAiplatformV1ResumeScheduleRequest" +}, +"response": { +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -24697,9 +24602,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.operations.cancel", +"id": "aiplatform.projects.locations.schedules.operations.cancel", "parameterOrder": [ "name" ], @@ -24707,7 +24612,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -24722,9 +24627,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.studies.operations.delete", +"id": "aiplatform.projects.locations.schedules.operations.delete", "parameterOrder": [ "name" ], @@ -24732,7 +24637,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -24747,9 +24652,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.studies.operations.get", +"id": "aiplatform.projects.locations.schedules.operations.get", "parameterOrder": [ "name" ], @@ -24757,7 +24662,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -24772,9 +24677,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.studies.operations.list", +"id": "aiplatform.projects.locations.schedules.operations.list", "parameterOrder": [ "name" ], @@ -24787,7 +24692,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true, "type": "string" }, @@ -24818,9 +24723,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.operations.wait", +"id": "aiplatform.projects.locations.schedules.operations.wait", "parameterOrder": [ "name" ], @@ -24828,7 +24733,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -24848,58 +24753,62 @@ ] } } +} +} }, -"trials": { +"specialistPools": { "methods": { -"addTrialMeasurement": { -"description": "Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement", +"create": { +"description": "Creates a SpecialistPool.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools", "httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.trials.addTrialMeasurement", +"id": "aiplatform.projects.locations.specialistPools.create", "parameterOrder": [ -"trialName" +"parent" ], "parameters": { -"trialName": { -"description": "Required. The name of the trial to add measurement. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", +"parent": { +"description": "Required. The parent Project name for the new SpecialistPool. The form is `projects/{project}/locations/{location}`.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+trialName}:addTrialMeasurement", +"path": "v1/{+parent}/specialistPools", "request": { -"$ref": "GoogleCloudAiplatformV1AddTrialMeasurementRequest" +"$ref": "GoogleCloudAiplatformV1SpecialistPool" }, "response": { -"$ref": "GoogleCloudAiplatformV1Trial" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"checkTrialEarlyStoppingState": { -"description": "Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState", +"delete": { +"description": "Deletes a SpecialistPool as well as all Specialists in the pool.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.specialistPools.delete", "parameterOrder": [ -"trialName" +"name" ], "parameters": { -"trialName": { -"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", +"force": { +"description": "If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.)", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Required. The resource name of the SpecialistPool to delete. Format: `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+trialName}:checkTrialEarlyStoppingState", -"request": { -"$ref": "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest" -}, +"path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -24907,224 +24816,99 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"complete": { -"description": "Marks a Trial as complete.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.trials.complete", +"get": { +"description": "Gets a SpecialistPool.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.specialistPools.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", +"description": "Required. The name of the SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:complete", -"request": { -"$ref": "GoogleCloudAiplatformV1CompleteTrialRequest" -}, +"path": "v1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1Trial" +"$ref": "GoogleCloudAiplatformV1SpecialistPool" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"create": { -"description": "Adds a user provided Trial to a Study.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.trials.create", +"list": { +"description": "Lists SpecialistPools in a Location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.specialistPools.list", "parameterOrder": [ "parent" ], "parameters": { +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty.", +"location": "query", +"type": "string" +}, "parent": { -"description": "Required. The resource name of the Study to create the Trial in. Format: `projects/{project}/locations/{location}/studies/{study}`", +"description": "Required. The name of the SpecialistPool's parent resource. Format: `projects/{project}/locations/{location}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" -} }, -"path": "v1/{+parent}/trials", -"request": { -"$ref": "GoogleCloudAiplatformV1Trial" -}, -"response": { -"$ref": "GoogleCloudAiplatformV1Trial" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Deletes a Trial.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", -"httpMethod": "DELETE", -"id": "aiplatform.projects.locations.studies.trials.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Gets a Trial.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.studies.trials.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the Trial resource. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleCloudAiplatformV1Trial" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists the Trials associated with a Study.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.studies.trials.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"pageSize": { -"description": "Optional. The number of Trials to retrieve per \"page\" of results. If unspecified, the service will pick an appropriate default.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", +"readMask": { +"description": "Mask specifying which fields to read. FieldMask represents a set of", +"format": "google-fieldmask", "location": "query", "type": "string" -}, -"parent": { -"description": "Required. The resource name of the Study to list the Trial from. Format: `projects/{project}/locations/{location}/studies/{study}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/trials", -"response": { -"$ref": "GoogleCloudAiplatformV1ListTrialsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"listOptimalTrials": { -"description": "Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.trials.listOptimalTrials", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. The name of the Study that the optimal Trial belongs to.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", -"required": true, -"type": "string" } }, -"path": "v1/{+parent}/trials:listOptimalTrials", -"request": { -"$ref": "GoogleCloudAiplatformV1ListOptimalTrialsRequest" -}, +"path": "v1/{+parent}/specialistPools", "response": { -"$ref": "GoogleCloudAiplatformV1ListOptimalTrialsResponse" +"$ref": "GoogleCloudAiplatformV1ListSpecialistPoolsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"stop": { -"description": "Stops a Trial.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.trials.stop", +"patch": { +"description": "Updates a SpecialistPool.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.specialistPools.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", +"description": "Required. The resource name of the SpecialistPool.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", "required": true, "type": "string" -} -}, -"path": "v1/{+name}:stop", -"request": { -"$ref": "GoogleCloudAiplatformV1StopTrialRequest" -}, -"response": { -"$ref": "GoogleCloudAiplatformV1Trial" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] }, -"suggest": { -"description": "Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.trials.suggest", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. The project and location that the Study belongs to. Format: `projects/{project}/locations/{location}/studies/{study}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", -"required": true, +"updateMask": { +"description": "Required. The update mask applies to the resource.", +"format": "google-fieldmask", +"location": "query", "type": "string" } }, -"path": "v1/{+parent}/trials:suggest", +"path": "v1/{+name}", "request": { -"$ref": "GoogleCloudAiplatformV1SuggestTrialsRequest" +"$ref": "GoogleCloudAiplatformV1SpecialistPool" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -25139,9 +24923,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.trials.operations.cancel", +"id": "aiplatform.projects.locations.specialistPools.operations.cancel", "parameterOrder": [ "name" ], @@ -25149,7 +24933,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -25164,9 +24948,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.studies.trials.operations.delete", +"id": "aiplatform.projects.locations.specialistPools.operations.delete", "parameterOrder": [ "name" ], @@ -25174,7 +24958,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -25189,9 +24973,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.studies.trials.operations.get", +"id": "aiplatform.projects.locations.specialistPools.operations.get", "parameterOrder": [ "name" ], @@ -25199,7 +24983,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -25214,9 +24998,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.studies.trials.operations.list", +"id": "aiplatform.projects.locations.specialistPools.operations.list", "parameterOrder": [ "name" ], @@ -25229,7 +25013,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", "required": true, "type": "string" }, @@ -25260,9 +25044,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.trials.operations.wait", +"id": "aiplatform.projects.locations.specialistPools.operations.wait", "parameterOrder": [ "name" ], @@ -25270,7 +25054,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -25292,531 +25076,436 @@ } } } -} -} }, -"tensorboards": { +"studies": { "methods": { -"batchRead": { -"description": "Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.batchRead", -"parameterOrder": [ -"tensorboard" -], -"parameters": { -"tensorboard": { -"description": "Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", -"required": true, -"type": "string" -}, -"timeSeries": { -"description": "Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", -"location": "query", -"repeated": true, -"type": "string" -} -}, -"path": "v1/{+tensorboard}:batchRead", -"response": { -"$ref": "GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "create": { -"description": "Creates a Tensorboard.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards", +"description": "Creates a Study. A resource name will be generated after creation of the Study.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.create", +"id": "aiplatform.projects.locations.studies.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project}/locations/{location}`", +"description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/tensorboards", +"path": "v1/{+parent}/studies", "request": { -"$ref": "GoogleCloudAiplatformV1Tensorboard" +"$ref": "GoogleCloudAiplatformV1Study" }, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1Study" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a Tensorboard.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", +"description": "Deletes a Study.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.tensorboards.delete", +"id": "aiplatform.projects.locations.studies.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the Tensorboard to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", +"description": "Required. The name of the Study resource to be deleted. Format: `projects/{project}/locations/{location}/studies/{study}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets a Tensorboard.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", +"description": "Gets a Study by name.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.get", +"id": "aiplatform.projects.locations.studies.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", +"description": "Required. The name of the Study resource. Format: `projects/{project}/locations/{location}/studies/{study}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1Tensorboard" +"$ref": "GoogleCloudAiplatformV1Study" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists Tensorboards in a Location.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards", +"description": "Lists all the studies in a region for an associated project.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.list", +"id": "aiplatform.projects.locations.studies.list", "parameterOrder": [ "parent" ], "parameters": { -"filter": { -"description": "Lists the Tensorboards that match the filter expression.", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Field to use to sort the list.", -"location": "query", -"type": "string" -}, "pageSize": { -"description": "The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.", +"description": "Optional. The maximum number of studies to return per \"page\" of results. If unspecified, service will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token.", +"description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource name of the Location to list Tensorboards. Format: `projects/{project}/locations/{location}`", +"description": "Required. The resource name of the Location to list the Study from. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" -}, -"readMask": { -"description": "Mask specifying which fields to read.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, -"path": "v1/{+parent}/tensorboards", +"path": "v1/{+parent}/studies", "response": { -"$ref": "GoogleCloudAiplatformV1ListTensorboardsResponse" +"$ref": "GoogleCloudAiplatformV1ListStudiesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, -"patch": { -"description": "Updates a Tensorboard.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", -"httpMethod": "PATCH", -"id": "aiplatform.projects.locations.tensorboards.patch", +"lookup": { +"description": "Looks a study up using the user-defined display_name field instead of the fully qualified resource name.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies:lookup", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.studies.lookup", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", +"parent": { +"description": "Required. The resource name of the Location to get the Study from. Format: `projects/{project}/locations/{location}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" -}, -"updateMask": { -"description": "Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, -"path": "v1/{+name}", +"path": "v1/{+parent}/studies:lookup", "request": { -"$ref": "GoogleCloudAiplatformV1Tensorboard" +"$ref": "GoogleCloudAiplatformV1LookupStudyRequest" }, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1Study" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} }, -"readSize": { -"description": "Returns the storage size for a given TensorBoard instance.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.readSize", +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.studies.operations.cancel", "parameterOrder": [ -"tensorboard" +"name" ], "parameters": { -"tensorboard": { -"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", +"name": { +"description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+tensorboard}:readSize", +"path": "v1/{+name}:cancel", "response": { -"$ref": "GoogleCloudAiplatformV1ReadTensorboardSizeResponse" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"readUsage": { -"description": "Returns a list of monthly active users for a given TensorBoard instance.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.readUsage", +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.studies.operations.delete", "parameterOrder": [ -"tensorboard" +"name" ], "parameters": { -"tensorboard": { -"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", +"name": { +"description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+tensorboard}:readUsage", +"path": "v1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1ReadTensorboardUsageResponse" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} }, -"resources": { -"experiments": { -"methods": { -"batchCreate": { -"description": "Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.batchCreate", +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.studies.operations.get", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.", +"name": { +"description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}:batchCreate", -"request": { -"$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest" -}, +"path": "v1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"create": { -"description": "Creates a TensorboardExperiment.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.create", +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.studies.operations.list", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" }, -"tensorboardExperimentId": { -"description": "Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.", +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", "location": "query", "type": "string" -} }, -"path": "v1/{+parent}/experiments", -"request": { -"$ref": "GoogleCloudAiplatformV1TensorboardExperiment" +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} }, +"path": "v1/{+name}/operations", "response": { -"$ref": "GoogleCloudAiplatformV1TensorboardExperiment" +"$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"delete": { -"description": "Deletes a TensorboardExperiment.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", -"httpMethod": "DELETE", -"id": "aiplatform.projects.locations.tensorboards.experiments.delete", +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.studies.operations.wait", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", +"description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", "required": true, "type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" } }, -"path": "v1/{+name}", +"path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} }, -"get": { -"description": "Gets a TensorboardExperiment.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.get", +"trials": { +"methods": { +"addTrialMeasurement": { +"description": "Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.studies.trials.addTrialMeasurement", "parameterOrder": [ -"name" +"trialName" ], "parameters": { -"name": { -"description": "Required. The name of the TensorboardExperiment resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", +"trialName": { +"description": "Required. The name of the trial to add measurement. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}", +"path": "v1/{+trialName}:addTrialMeasurement", +"request": { +"$ref": "GoogleCloudAiplatformV1AddTrialMeasurementRequest" +}, "response": { -"$ref": "GoogleCloudAiplatformV1TensorboardExperiment" +"$ref": "GoogleCloudAiplatformV1Trial" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" -] -}, -"list": { -"description": "Lists TensorboardExperiments in a Location.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Lists the TensorboardExperiments that match the filter expression.", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Field to use to sort the list.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", -"required": true, -"type": "string" -}, -"readMask": { -"description": "Mask specifying which fields to read.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -} -}, -"path": "v1/{+parent}/experiments", -"response": { -"$ref": "GoogleCloudAiplatformV1ListTensorboardExperimentsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, -"patch": { -"description": "Updates a TensorboardExperiment.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", -"httpMethod": "PATCH", -"id": "aiplatform.projects.locations.tensorboards.experiments.patch", +"checkTrialEarlyStoppingState": { +"description": "Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState", "parameterOrder": [ -"name" +"trialName" ], "parameters": { -"name": { -"description": "Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", +"trialName": { +"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true, "type": "string" -}, -"updateMask": { -"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, -"path": "v1/{+name}", +"path": "v1/{+trialName}:checkTrialEarlyStoppingState", "request": { -"$ref": "GoogleCloudAiplatformV1TensorboardExperiment" +"$ref": "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest" }, "response": { -"$ref": "GoogleCloudAiplatformV1TensorboardExperiment" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"write": { -"description": "Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write", +"complete": { +"description": "Marks a Trial as complete.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.write", +"id": "aiplatform.projects.locations.studies.trials.complete", "parameterOrder": [ -"tensorboardExperiment" +"name" ], "parameters": { -"tensorboardExperiment": { -"description": "Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", +"name": { +"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+tensorboardExperiment}:write", +"path": "v1/{+name}:complete", "request": { -"$ref": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest" +"$ref": "GoogleCloudAiplatformV1CompleteTrialRequest" }, "response": { -"$ref": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse" +"$ref": "GoogleCloudAiplatformV1Trial" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} }, -"resources": { -"operations": { -"methods": { -"cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel", +"create": { +"description": "Adds a user provided Trial to a Study.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.operations.cancel", +"id": "aiplatform.projects.locations.studies.trials.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", +"parent": { +"description": "Required. The resource name of the Study to create the Trial in. Format: `projects/{project}/locations/{location}/studies/{study}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:cancel", +"path": "v1/{+parent}/trials", +"request": { +"$ref": "GoogleCloudAiplatformV1Trial" +}, "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleCloudAiplatformV1Trial" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", +"description": "Deletes a Trial.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.tensorboards.experiments.operations.delete", +"id": "aiplatform.projects.locations.studies.trials.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to be deleted.", +"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true, "type": "string" } @@ -25830,604 +25519,671 @@ ] }, "get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", +"description": "Gets a Trial.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.operations.get", +"id": "aiplatform.projects.locations.studies.trials.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. The name of the Trial resource. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1Trial" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations", +"description": "Lists the Trials associated with a Study.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.operations.list", +"id": "aiplatform.projects.locations.studies.trials.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", -"type": "string" -}, -"name": { -"description": "The name of the operation's parent resource.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", -"required": true, -"type": "string" -}, "pageSize": { -"description": "The standard list page size.", +"description": "Optional. The number of Trials to retrieve per \"page\" of results. If unspecified, the service will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token.", +"description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", "location": "query", "type": "string" }, -"returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", -"location": "query", -"type": "boolean" +"parent": { +"description": "Required. The resource name of the Study to list the Trial from. Format: `projects/{project}/locations/{location}/studies/{study}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", +"required": true, +"type": "string" } }, -"path": "v1/{+name}/operations", +"path": "v1/{+parent}/trials", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudAiplatformV1ListTrialsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait", +"listOptimalTrials": { +"description": "Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.operations.wait", +"id": "aiplatform.projects.locations.studies.trials.listOptimalTrials", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource to wait on.", +"parent": { +"description": "Required. The name of the Study that the optimal Trial belongs to.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" -}, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", -"location": "query", -"type": "string" } }, -"path": "v1/{+name}:wait", +"path": "v1/{+parent}/trials:listOptimalTrials", +"request": { +"$ref": "GoogleCloudAiplatformV1ListOptimalTrialsRequest" +}, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1ListOptimalTrialsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} }, -"runs": { -"methods": { -"batchCreate": { -"description": "Batch create TensorboardRuns.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate", +"stop": { +"description": "Stops a Trial.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate", +"id": "aiplatform.projects.locations.studies.trials.stop", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The parent field in the CreateTensorboardRunRequest messages must match this field.", +"name": { +"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/runs:batchCreate", +"path": "v1/{+name}:stop", "request": { -"$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest" +"$ref": "GoogleCloudAiplatformV1StopTrialRequest" }, "response": { -"$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse" +"$ref": "GoogleCloudAiplatformV1Trial" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"create": { -"description": "Creates a TensorboardRun.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs", +"suggest": { +"description": "Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.create", +"id": "aiplatform.projects.locations.studies.trials.suggest", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", +"description": "Required. The project and location that the Study belongs to. Format: `projects/{project}/locations/{location}/studies/{study}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" -}, -"tensorboardRunId": { -"description": "Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.", -"location": "query", -"type": "string" } }, -"path": "v1/{+parent}/runs", +"path": "v1/{+parent}/trials:suggest", "request": { -"$ref": "GoogleCloudAiplatformV1TensorboardRun" +"$ref": "GoogleCloudAiplatformV1SuggestTrialsRequest" }, "response": { -"$ref": "GoogleCloudAiplatformV1TensorboardRun" +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.studies.trials.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a TensorboardRun.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.delete", +"id": "aiplatform.projects.locations.studies.trials.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the TensorboardRun to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", +"description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets a TensorboardRun.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.get", +"id": "aiplatform.projects.locations.studies.trials.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the TensorboardRun resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", +"description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1TensorboardRun" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists TensorboardRuns in a Location.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs", +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.list", +"id": "aiplatform.projects.locations.studies.trials.operations.list", "parameterOrder": [ -"parent" +"name" ], "parameters": { "filter": { -"description": "Lists the TensorboardRuns that match the filter expression.", +"description": "The standard list filter.", "location": "query", "type": "string" }, -"orderBy": { -"description": "Field to use to sort the list.", -"location": "query", +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", +"required": true, "type": "string" }, "pageSize": { -"description": "The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", +"description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token.", +"description": "The standard list page token.", "location": "query", "type": "string" }, -"parent": { -"description": "Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", -"required": true, -"type": "string" -}, -"readMask": { -"description": "Mask specifying which fields to read.", -"format": "google-fieldmask", +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", -"type": "string" +"type": "boolean" } }, -"path": "v1/{+parent}/runs", +"path": "v1/{+name}/operations", "response": { -"$ref": "GoogleCloudAiplatformV1ListTensorboardRunsResponse" +"$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, -"patch": { -"description": "Updates a TensorboardRun.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", -"httpMethod": "PATCH", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.patch", +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.studies.trials.operations.wait", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", +"description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, -"updateMask": { -"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", -"format": "google-fieldmask", +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", "location": "query", "type": "string" } }, -"path": "v1/{+name}", -"request": { -"$ref": "GoogleCloudAiplatformV1TensorboardRun" -}, +"path": "v1/{+name}:wait", "response": { -"$ref": "GoogleCloudAiplatformV1TensorboardRun" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} +} +} +} +} }, -"write": { -"description": "Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.write", +"tensorboards": { +"methods": { +"batchRead": { +"description": "Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tensorboards.batchRead", "parameterOrder": [ -"tensorboardRun" +"tensorboard" ], "parameters": { -"tensorboardRun": { -"description": "Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", +"tensorboard": { +"description": "Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" -} }, -"path": "v1/{+tensorboardRun}:write", -"request": { -"$ref": "GoogleCloudAiplatformV1WriteTensorboardRunDataRequest" +"timeSeries": { +"description": "Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", +"location": "query", +"repeated": true, +"type": "string" +} }, +"path": "v1/{+tensorboard}:batchRead", "response": { -"$ref": "GoogleCloudAiplatformV1WriteTensorboardRunDataResponse" +"$ref": "GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} }, -"resources": { -"operations": { -"methods": { -"cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel", +"create": { +"description": "Creates a Tensorboard.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel", +"id": "aiplatform.projects.locations.tensorboards.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", +"parent": { +"description": "Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project}/locations/{location}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:cancel", +"path": "v1/{+parent}/tensorboards", +"request": { +"$ref": "GoogleCloudAiplatformV1Tensorboard" +}, "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", +"description": "Deletes a Tensorboard.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete", +"id": "aiplatform.projects.locations.tensorboards.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to be deleted.", +"description": "Required. The name of the Tensorboard to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", +"description": "Gets a Tensorboard.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.get", +"id": "aiplatform.projects.locations.tensorboards.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1Tensorboard" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" ] }, "list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations", +"description": "Lists Tensorboards in a Location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.list", +"id": "aiplatform.projects.locations.tensorboards.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { "filter": { -"description": "The standard list filter.", +"description": "Lists the Tensorboards that match the filter expression.", "location": "query", "type": "string" }, -"name": { -"description": "The name of the operation's parent resource.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", -"required": true, +"orderBy": { +"description": "Field to use to sort the list.", +"location": "query", "type": "string" }, "pageSize": { -"description": "The standard list page size.", +"description": "The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token.", +"description": "A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token.", "location": "query", "type": "string" }, -"returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"parent": { +"description": "Required. The resource name of the Location to list Tensorboards. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"readMask": { +"description": "Mask specifying which fields to read.", +"format": "google-fieldmask", "location": "query", -"type": "boolean" +"type": "string" } }, -"path": "v1/{+name}/operations", +"path": "v1/{+parent}/tensorboards", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudAiplatformV1ListTensorboardsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" ] }, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait", +"patch": { +"description": "Updates a Tensorboard.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.tensorboards.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to wait on.", +"description": "Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" }, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", +"format": "google-fieldmask", "location": "query", "type": "string" } }, -"path": "v1/{+name}:wait", +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1Tensorboard" +}, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"readSize": { +"description": "Returns the storage size for a given TensorBoard instance.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tensorboards.readSize", +"parameterOrder": [ +"tensorboard" +], +"parameters": { +"tensorboard": { +"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+tensorboard}:readSize", +"response": { +"$ref": "GoogleCloudAiplatformV1ReadTensorboardSizeResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"readUsage": { +"description": "Returns a list of monthly active users for a given TensorBoard instance.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tensorboards.readUsage", +"parameterOrder": [ +"tensorboard" +], +"parameters": { +"tensorboard": { +"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", +"required": true, +"type": "string" } +}, +"path": "v1/{+tensorboard}:readUsage", +"response": { +"$ref": "GoogleCloudAiplatformV1ReadTensorboardUsageResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, -"timeSeries": { +"resources": { +"experiments": { "methods": { -"create": { -"description": "Creates a TensorboardTimeSeries.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries", +"batchCreate": { +"description": "Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create", +"id": "aiplatform.projects.locations.tensorboards.experiments.batchCreate", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", +"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" -}, -"tensorboardTimeSeriesId": { -"description": "Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match \"a-z0-9{0, 127}\"", -"location": "query", -"type": "string" } }, -"path": "v1/{+parent}/timeSeries", +"path": "v1/{+parent}:batchCreate", "request": { -"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" +"$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest" }, "response": { -"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" +"$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"delete": { -"description": "Deletes a TensorboardTimeSeries.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", -"httpMethod": "DELETE", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete", +"create": { +"description": "Creates a TensorboardExperiment.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tensorboards.experiments.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", +"parent": { +"description": "Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" +}, +"tensorboardExperimentId": { +"description": "Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.", +"location": "query", +"type": "string" } }, -"path": "v1/{+name}", +"path": "v1/{+parent}/experiments", +"request": { +"$ref": "GoogleCloudAiplatformV1TensorboardExperiment" +}, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1TensorboardExperiment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"exportTensorboardTimeSeries": { -"description": "Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries", +"delete": { +"description": "Deletes a TensorboardExperiment.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.tensorboards.experiments.delete", "parameterOrder": [ -"tensorboardTimeSeries" +"name" ], "parameters": { -"tensorboardTimeSeries": { -"description": "Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", +"name": { +"description": "Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries", -"request": { -"$ref": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest" -}, +"path": "v1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets a TensorboardTimeSeries.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", +"description": "Gets a TensorboardExperiment.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get", +"id": "aiplatform.projects.locations.tensorboards.experiments.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", +"description": "Required. The name of the TensorboardExperiment resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" +"$ref": "GoogleCloudAiplatformV1TensorboardExperiment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -26435,16 +26191,16 @@ ] }, "list": { -"description": "Lists TensorboardTimeSeries in a Location.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries", +"description": "Lists TensorboardExperiments in a Location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list", +"id": "aiplatform.projects.locations.tensorboards.experiments.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { -"description": "Lists the TensorboardTimeSeries that match the filter expression.", +"description": "Lists the TensorboardExperiments that match the filter expression.", "location": "query", "type": "string" }, @@ -26454,20 +26210,20 @@ "type": "string" }, "pageSize": { -"description": "The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", +"description": "The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token.", +"description": "A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", +"description": "Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" }, @@ -26478,9 +26234,9 @@ "type": "string" } }, -"path": "v1/{+parent}/timeSeries", +"path": "v1/{+parent}/experiments", "response": { -"$ref": "GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse" +"$ref": "GoogleCloudAiplatformV1ListTensorboardExperimentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -26488,23 +26244,23 @@ ] }, "patch": { -"description": "Updates a TensorboardTimeSeries.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", +"description": "Updates a TensorboardExperiment.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", "httpMethod": "PATCH", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch", +"id": "aiplatform.projects.locations.tensorboards.experiments.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Output only. Name of the TensorboardTimeSeries.", +"description": "Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", +"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -26512,82 +26268,41 @@ }, "path": "v1/{+name}", "request": { -"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" +"$ref": "GoogleCloudAiplatformV1TensorboardExperiment" }, "response": { -"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" +"$ref": "GoogleCloudAiplatformV1TensorboardExperiment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"read": { -"description": "Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read", +"write": { +"description": "Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tensorboards.experiments.write", "parameterOrder": [ -"tensorboardTimeSeries" +"tensorboardExperiment" ], "parameters": { -"filter": { -"description": "Reads the TensorboardTimeSeries' data that match the filter expression.", -"location": "query", -"type": "string" -}, -"maxDataPoints": { -"description": "The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"tensorboardTimeSeries": { -"description": "Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", +"tensorboardExperiment": { +"description": "Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+tensorboardTimeSeries}:read", -"response": { -"$ref": "GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" -] -}, -"readBlobData": { -"description": "Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData", -"parameterOrder": [ -"timeSeries" -], -"parameters": { -"blobIds": { -"description": "IDs of the blobs to read.", -"location": "query", -"repeated": true, -"type": "string" -}, -"timeSeries": { -"description": "Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", -"required": true, -"type": "string" -} +"path": "v1/{+tensorboardExperiment}:write", +"request": { +"$ref": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest" }, -"path": "v1/{+timeSeries}:readBlobData", "response": { -"$ref": "GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse" +"$ref": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } }, @@ -26596,9 +26311,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel", +"id": "aiplatform.projects.locations.tensorboards.experiments.operations.cancel", "parameterOrder": [ "name" ], @@ -26606,7 +26321,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -26621,9 +26336,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete", +"id": "aiplatform.projects.locations.tensorboards.experiments.operations.delete", "parameterOrder": [ "name" ], @@ -26631,7 +26346,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -26646,9 +26361,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get", +"id": "aiplatform.projects.locations.tensorboards.experiments.operations.get", "parameterOrder": [ "name" ], @@ -26656,7 +26371,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -26671,9 +26386,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list", +"id": "aiplatform.projects.locations.tensorboards.experiments.operations.list", "parameterOrder": [ "name" ], @@ -26686,7 +26401,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" }, @@ -26717,9 +26432,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait", +"id": "aiplatform.projects.locations.tensorboards.experiments.operations.wait", "parameterOrder": [ "name" ], @@ -26727,7 +26442,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -26747,321 +26462,231 @@ ] } } -} -} -} -} -} -} }, -"operations": { +"runs": { "methods": { -"cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel", +"batchCreate": { +"description": "Batch create TensorboardRuns.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.operations.cancel", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", +"parent": { +"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The parent field in the CreateTensorboardRunRequest messages must match this field.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:cancel", +"path": "v1/{+parent}/runs:batchCreate", +"request": { +"$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest" +}, "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"create": { +"description": "Creates a TensorboardRun.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", +"required": true, +"type": "string" +}, +"tensorboardRunId": { +"description": "Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/runs", +"request": { +"$ref": "GoogleCloudAiplatformV1TensorboardRun" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1TensorboardRun" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", +"description": "Deletes a TensorboardRun.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.tensorboards.operations.delete", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to be deleted.", +"description": "Required. The name of the TensorboardRun to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", +"description": "Gets a TensorboardRun.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.operations.get", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. The name of the TensorboardRun resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1TensorboardRun" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" ] }, "list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations", +"description": "Lists TensorboardRuns in a Location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.operations.list", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { "filter": { -"description": "The standard list filter.", +"description": "Lists the TensorboardRuns that match the filter expression.", "location": "query", "type": "string" }, -"name": { -"description": "The name of the operation's parent resource.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", -"required": true, +"orderBy": { +"description": "Field to use to sort the list.", +"location": "query", "type": "string" }, "pageSize": { -"description": "The standard list page size.", +"description": "The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token.", +"description": "A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token.", "location": "query", "type": "string" }, -"returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"parent": { +"description": "Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", +"required": true, +"type": "string" +}, +"readMask": { +"description": "Mask specifying which fields to read.", +"format": "google-fieldmask", "location": "query", -"type": "boolean" +"type": "string" } }, -"path": "v1/{+name}/operations", +"path": "v1/{+parent}/runs", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudAiplatformV1ListTensorboardRunsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" ] }, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.operations.wait", +"patch": { +"description": "Updates a TensorboardRun.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to wait on.", +"description": "Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "type": "string" }, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", +"format": "google-fieldmask", "location": "query", "type": "string" } }, -"path": "v1/{+name}:wait", +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1TensorboardRun" +}, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1TensorboardRun" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} }, -"trainingPipelines": { -"methods": { -"cancel": { -"description": "Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel", +"write": { +"description": "Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write", "httpMethod": "POST", -"id": "aiplatform.projects.locations.trainingPipelines.cancel", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.write", "parameterOrder": [ -"name" +"tensorboardRun" ], "parameters": { -"name": { -"description": "Required. The name of the TrainingPipeline to cancel. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", +"tensorboardRun": { +"description": "Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:cancel", +"path": "v1/{+tensorboardRun}:write", "request": { -"$ref": "GoogleCloudAiplatformV1CancelTrainingPipelineRequest" +"$ref": "GoogleCloudAiplatformV1WriteTensorboardRunDataRequest" }, "response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"create": { -"description": "Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.trainingPipelines.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/trainingPipelines", -"request": { -"$ref": "GoogleCloudAiplatformV1TrainingPipeline" -}, -"response": { -"$ref": "GoogleCloudAiplatformV1TrainingPipeline" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Deletes a TrainingPipeline.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", -"httpMethod": "DELETE", -"id": "aiplatform.projects.locations.trainingPipelines.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Gets a TrainingPipeline.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.trainingPipelines.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleCloudAiplatformV1TrainingPipeline" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists TrainingPipelines in a Location.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.trainingPipelines.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"PIPELINE_STATE_SUCCEEDED\" AND display_name:\"my_pipeline_*\"` * `state!=\"PIPELINE_STATE_FAILED\" OR display_name=\"my_pipeline\"` * `NOT display_name=\"my_pipeline\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `training_task_definition:\"*automl_text_classification*\"`", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -}, -"readMask": { -"description": "Mask specifying which fields to read.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -} -}, -"path": "v1/{+parent}/trainingPipelines", -"response": { -"$ref": "GoogleCloudAiplatformV1ListTrainingPipelinesResponse" +"$ref": "GoogleCloudAiplatformV1WriteTensorboardRunDataResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -27073,9 +26698,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.trainingPipelines.operations.cancel", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel", "parameterOrder": [ "name" ], @@ -27083,7 +26708,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -27098,9 +26723,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.trainingPipelines.operations.delete", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete", "parameterOrder": [ "name" ], @@ -27108,7 +26733,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -27123,9 +26748,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.trainingPipelines.operations.get", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.get", "parameterOrder": [ "name" ], @@ -27133,7 +26758,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -27148,9 +26773,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.trainingPipelines.operations.list", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.list", "parameterOrder": [ "name" ], @@ -27163,7 +26788,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "type": "string" }, @@ -27194,9 +26819,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.projects.locations.trainingPipelines.operations.wait", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait", "parameterOrder": [ "name" ], @@ -27204,7 +26829,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -27224,160 +26849,276 @@ ] } } -} -} }, -"tuningJobs": { +"timeSeries": { "methods": { -"cancel": { -"description": "Cancels a tuning job. Starts an asynchronous cancellation request. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the tuning job is not deleted. Instead, its state is set to `CANCELLED`, and `error` is set to a status with a `google.rpc.Status.code` of 1, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel", +"create": { +"description": "Creates a TensorboardTimeSeries.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tuningJobs.cancel", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "Required. The name of the tuning job to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", +"parent": { +"description": "Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "type": "string" +}, +"tensorboardTimeSeriesId": { +"description": "Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match \"a-z0-9{0, 127}\"", +"location": "query", +"type": "string" } }, -"path": "v1/{+name}:cancel", +"path": "v1/{+parent}/timeSeries", "request": { -"$ref": "GoogleCloudAiplatformV1CancelTuningJobRequest" +"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" }, "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"create": { -"description": "Creates a tuning job. A created tuning job will be subsequently executed to start the model tuning process.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs", +"delete": { +"description": "Deletes a TensorboardTimeSeries.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"exportTensorboardTimeSeries": { +"description": "Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tuningJobs.create", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries", "parameterOrder": [ -"parent" +"tensorboardTimeSeries" ], "parameters": { -"parent": { -"description": "Required. The resource name of the location to create the tuning job in. Format: `projects/{project}/locations/{location}`", +"tensorboardTimeSeries": { +"description": "Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/tuningJobs", +"path": "v1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries", "request": { -"$ref": "GoogleCloudAiplatformV1TuningJob" +"$ref": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest" }, "response": { -"$ref": "GoogleCloudAiplatformV1TuningJob" +"$ref": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets a tuning job.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}", +"description": "Gets a TensorboardTimeSeries.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tuningJobs.get", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the tuning job to retrieve. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", +"description": "Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1TuningJob" +"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" ] }, "list": { -"description": "Lists tuning jobs in a location.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs", +"description": "Lists TensorboardTimeSeries in a Location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tuningJobs.list", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { -"description": "Optional. The standard list filter.", +"description": "Lists the TensorboardTimeSeries that match the filter expression.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field to use to sort the list.", "location": "query", "type": "string" }, "pageSize": { -"description": "Optional. The standard list page size.", +"description": "The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. The standard list page token. Typically obtained from ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJobs call.", +"description": "A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource name of the location to list the tuning jobs from. Format: `projects/{project}/locations/{location}`", +"description": "Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "type": "string" +}, +"readMask": { +"description": "Mask specifying which fields to read.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, -"path": "v1/{+parent}/tuningJobs", +"path": "v1/{+parent}/timeSeries", "response": { -"$ref": "GoogleCloudAiplatformV1ListTuningJobsResponse" +"$ref": "GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" ] }, -"rebaseTunedModel": { -"description": "Rebase a tuned model. A rebase operation takes a model that was previously tuned on a base model version, and retunes it on a new base model version. The rebase operation creates a new tuning job and a new tuned model.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel", +"patch": { +"description": "Updates a TensorboardTimeSeries.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The resource name of the location in which to rebase the Model. Format: `projects/{project}/locations/{location}`", +"name": { +"description": "Output only. Name of the TensorboardTimeSeries.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", "required": true, "type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, -"path": "v1/{+parent}/tuningJobs:rebaseTunedModel", +"path": "v1/{+name}", "request": { -"$ref": "GoogleCloudAiplatformV1RebaseTunedModelRequest" +"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" }, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"read": { +"description": "Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read", +"parameterOrder": [ +"tensorboardTimeSeries" +], +"parameters": { +"filter": { +"description": "Reads the TensorboardTimeSeries' data that match the filter expression.", +"location": "query", +"type": "string" +}, +"maxDataPoints": { +"description": "The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"tensorboardTimeSeries": { +"description": "Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+tensorboardTimeSeries}:read", +"response": { +"$ref": "GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"readBlobData": { +"description": "Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData", +"parameterOrder": [ +"timeSeries" +], +"parameters": { +"blobIds": { +"description": "IDs of the blobs to read.", +"location": "query", +"repeated": true, +"type": "string" +}, +"timeSeries": { +"description": "Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+timeSeries}:readBlobData", +"response": { +"$ref": "GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] } }, "resources": { @@ -27385,9 +27126,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tuningJobs.operations.cancel", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel", "parameterOrder": [ "name" ], @@ -27395,7 +27136,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -27410,9 +27151,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.tuningJobs.operations.delete", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete", "parameterOrder": [ "name" ], @@ -27420,7 +27161,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -27435,9 +27176,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tuningJobs.operations.get", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get", "parameterOrder": [ "name" ], @@ -27445,7 +27186,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -27460,9 +27201,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tuningJobs.operations.list", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list", "parameterOrder": [ "name" ], @@ -27475,7 +27216,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", "required": true, "type": "string" }, @@ -27503,6 +27244,37 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } } @@ -27512,372 +27284,286 @@ } } }, -"publishers": { -"resources": { -"models": { +"operations": { "methods": { -"computeTokens": { -"description": "Return a list of tokens based on the input text.", -"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:computeTokens", +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.publishers.models.computeTokens", +"id": "aiplatform.projects.locations.tensorboards.operations.cancel", "parameterOrder": [ -"endpoint" +"name" ], "parameters": { -"endpoint": { -"description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", +"name": { +"description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^publishers/[^/]+/models/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+endpoint}:computeTokens", -"request": { -"$ref": "GoogleCloudAiplatformV1ComputeTokensRequest" -}, +"path": "v1/{+name}:cancel", "response": { -"$ref": "GoogleCloudAiplatformV1ComputeTokensResponse" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"countTokens": { -"description": "Perform a token counting.", -"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:countTokens", -"httpMethod": "POST", -"id": "aiplatform.publishers.models.countTokens", +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.tensorboards.operations.delete", "parameterOrder": [ -"endpoint" +"name" ], "parameters": { -"endpoint": { -"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"name": { +"description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^publishers/[^/]+/models/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+endpoint}:countTokens", -"request": { -"$ref": "GoogleCloudAiplatformV1CountTokensRequest" -}, +"path": "v1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1CountTokensResponse" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"fetchPredictOperation": { -"description": "Fetch an asynchronous online prediction operation.", -"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation", -"httpMethod": "POST", -"id": "aiplatform.publishers.models.fetchPredictOperation", +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tensorboards.operations.get", "parameterOrder": [ -"endpoint" +"name" ], "parameters": { -"endpoint": { -"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", +"name": { +"description": "The name of the operation resource.", "location": "path", -"pattern": "^publishers/[^/]+/models/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+endpoint}:fetchPredictOperation", -"request": { -"$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest" -}, +"path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" -] -}, -"generateContent": { -"description": "Generate content with multimodal inputs.", -"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:generateContent", -"httpMethod": "POST", -"id": "aiplatform.publishers.models.generateContent", -"parameterOrder": [ -"model" -], -"parameters": { -"model": { -"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", -"location": "path", -"pattern": "^publishers/[^/]+/models/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+model}:generateContent", -"request": { -"$ref": "GoogleCloudAiplatformV1GenerateContentRequest" -}, -"response": { -"$ref": "GoogleCloudAiplatformV1GenerateContentResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, -"get": { -"description": "Gets a Model Garden publisher model.", -"flatPath": "v1/publishers/{publishersId}/models/{modelsId}", +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations", "httpMethod": "GET", -"id": "aiplatform.publishers.models.get", +"id": "aiplatform.projects.locations.tensorboards.operations.list", "parameterOrder": [ "name" ], "parameters": { -"huggingFaceToken": { -"description": "Optional. Token used to access Hugging Face gated models.", -"location": "query", -"type": "string" -}, -"isHuggingFaceModel": { -"description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.", -"location": "query", -"type": "boolean" -}, -"languageCode": { -"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.", +"filter": { +"description": "The standard list filter.", "location": "query", "type": "string" }, "name": { -"description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`", +"description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^publishers/[^/]+/models/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" }, -"view": { -"description": "Optional. PublisherModel view specifying which fields to read.", -"enum": [ -"PUBLISHER_MODEL_VIEW_UNSPECIFIED", -"PUBLISHER_MODEL_VIEW_BASIC", -"PUBLISHER_MODEL_VIEW_FULL", -"PUBLISHER_MODEL_VERSION_VIEW_BASIC" -], -"enumDescriptions": [ -"The default / unset value. The API will default to the BASIC view.", -"Include basic metadata about the publisher model, but not the full contents.", -"Include everything.", -"Include: VersionId, ModelVersionExternalName, and SupportedActions." -], +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, -"path": "v1/{+name}", +"path": "v1/{+name}/operations", "response": { -"$ref": "GoogleCloudAiplatformV1PublisherModel" +"$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"predict": { -"description": "", -"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:predict", +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.publishers.models.predict", +"id": "aiplatform.projects.locations.tensorboards.operations.wait", "parameterOrder": [ -"endpoint" +"name" ], "parameters": { -"endpoint": { -"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"name": { +"description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^publishers/[^/]+/models/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", "required": true, "type": "string" -} -}, -"path": "v1/{+endpoint}:predict", -"request": { -"$ref": "GoogleCloudAiplatformV1PredictRequest" -}, -"response": { -"$ref": "GoogleCloudAiplatformV1PredictResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" -] }, -"predictLongRunning": { -"description": "", -"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:predictLongRunning", -"httpMethod": "POST", -"id": "aiplatform.publishers.models.predictLongRunning", -"parameterOrder": [ -"endpoint" -], -"parameters": { -"endpoint": { -"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", -"location": "path", -"pattern": "^publishers/[^/]+/models/[^/]+$", -"required": true, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", "type": "string" } }, -"path": "v1/{+endpoint}:predictLongRunning", -"request": { -"$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest" -}, +"path": "v1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] +} +} +} +} }, -"streamGenerateContent": { -"description": "Generate content with multimodal inputs with streaming support.", -"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent", +"trainingPipelines": { +"methods": { +"cancel": { +"description": "Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel", "httpMethod": "POST", -"id": "aiplatform.publishers.models.streamGenerateContent", +"id": "aiplatform.projects.locations.trainingPipelines.cancel", "parameterOrder": [ -"model" +"name" ], "parameters": { -"model": { -"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"name": { +"description": "Required. The name of the TrainingPipeline to cancel. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", "location": "path", -"pattern": "^publishers/[^/]+/models/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+model}:streamGenerateContent", +"path": "v1/{+name}:cancel", "request": { -"$ref": "GoogleCloudAiplatformV1GenerateContentRequest" +"$ref": "GoogleCloudAiplatformV1CancelTrainingPipelineRequest" }, "response": { -"$ref": "GoogleCloudAiplatformV1GenerateContentResponse" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} }, -"ragCorpora": { -"resources": { -"operations": { -"methods": { -"cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel", +"create": { +"description": "Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", "httpMethod": "POST", -"id": "aiplatform.ragCorpora.operations.cancel", +"id": "aiplatform.projects.locations.trainingPipelines.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", +"parent": { +"description": "Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}`", "location": "path", -"pattern": "^ragCorpora/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:cancel", +"path": "v1/{+parent}/trainingPipelines", +"request": { +"$ref": "GoogleCloudAiplatformV1TrainingPipeline" +}, "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleCloudAiplatformV1TrainingPipeline" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}", +"description": "Deletes a TrainingPipeline.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", "httpMethod": "DELETE", -"id": "aiplatform.ragCorpora.operations.delete", +"id": "aiplatform.projects.locations.trainingPipelines.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to be deleted.", +"description": "Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", "location": "path", -"pattern": "^ragCorpora/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}", +"description": "Gets a TrainingPipeline.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", "httpMethod": "GET", -"id": "aiplatform.ragCorpora.operations.get", +"id": "aiplatform.projects.locations.trainingPipelines.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", "location": "path", -"pattern": "^ragCorpora/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1TrainingPipeline" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/ragCorpora/{ragCorporaId}/operations", +"description": "Lists TrainingPipelines in a Location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", "httpMethod": "GET", -"id": "aiplatform.ragCorpora.operations.list", +"id": "aiplatform.projects.locations.trainingPipelines.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { "filter": { -"description": "The standard list filter.", +"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"PIPELINE_STATE_SUCCEEDED\" AND display_name:\"my_pipeline_*\"` * `state!=\"PIPELINE_STATE_FAILED\" OR display_name=\"my_pipeline\"` * `NOT display_name=\"my_pipeline\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `training_task_definition:\"*automl_text_classification*\"`", "location": "query", "type": "string" }, -"name": { -"description": "The name of the operation's parent resource.", -"location": "path", -"pattern": "^ragCorpora/[^/]+$", -"required": true, -"type": "string" -}, "pageSize": { "description": "The standard list page size.", "format": "int32", @@ -27885,66 +27571,1470 @@ "type": "integer" }, "pageToken": { -"description": "The standard list page token.", +"description": "The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.", "location": "query", "type": "string" -}, -"returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", -"location": "query", -"type": "boolean" +}, +"parent": { +"description": "Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"readMask": { +"description": "Mask specifying which fields to read.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/trainingPipelines", +"response": { +"$ref": "GoogleCloudAiplatformV1ListTrainingPipelinesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.trainingPipelines.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.trainingPipelines.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.trainingPipelines.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.trainingPipelines.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.trainingPipelines.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"tuningJobs": { +"methods": { +"cancel": { +"description": "Cancels a tuning job. Starts an asynchronous cancellation request. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the tuning job is not deleted. Instead, its state is set to `CANCELLED`, and `error` is set to a status with a `google.rpc.Status.code` of 1, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tuningJobs.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the tuning job to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"request": { +"$ref": "GoogleCloudAiplatformV1CancelTuningJobRequest" +}, +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"create": { +"description": "Creates a tuning job. A created tuning job will be subsequently executed to start the model tuning process.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tuningJobs.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the location to create the tuning job in. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/tuningJobs", +"request": { +"$ref": "GoogleCloudAiplatformV1TuningJob" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1TuningJob" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a tuning job.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tuningJobs.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the tuning job to retrieve. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1TuningJob" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists tuning jobs in a location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tuningJobs.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The standard list filter.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The standard list page token. Typically obtained from ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJobs call.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the location to list the tuning jobs from. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/tuningJobs", +"response": { +"$ref": "GoogleCloudAiplatformV1ListTuningJobsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"rebaseTunedModel": { +"description": "Rebase a tuned model. A rebase operation takes a model that was previously tuned on a base model version, and retunes it on a new base model version. The rebase operation creates a new tuning job and a new tuned model.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the location in which to rebase the Model. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/tuningJobs:rebaseTunedModel", +"request": { +"$ref": "GoogleCloudAiplatformV1RebaseTunedModelRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tuningJobs.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.tuningJobs.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tuningJobs.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tuningJobs.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +}, +"publishers": { +"resources": { +"models": { +"methods": { +"computeTokens": { +"description": "Return a list of tokens based on the input text.", +"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:computeTokens", +"httpMethod": "POST", +"id": "aiplatform.publishers.models.computeTokens", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"endpoint": { +"description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", +"location": "path", +"pattern": "^publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+endpoint}:computeTokens", +"request": { +"$ref": "GoogleCloudAiplatformV1ComputeTokensRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1ComputeTokensResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"countTokens": { +"description": "Perform a token counting.", +"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:countTokens", +"httpMethod": "POST", +"id": "aiplatform.publishers.models.countTokens", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"endpoint": { +"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"location": "path", +"pattern": "^publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+endpoint}:countTokens", +"request": { +"$ref": "GoogleCloudAiplatformV1CountTokensRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1CountTokensResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"fetchPredictOperation": { +"description": "Fetch an asynchronous online prediction operation.", +"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation", +"httpMethod": "POST", +"id": "aiplatform.publishers.models.fetchPredictOperation", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", +"location": "path", +"pattern": "^publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+endpoint}:fetchPredictOperation", +"request": { +"$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"generateContent": { +"description": "Generate content with multimodal inputs.", +"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:generateContent", +"httpMethod": "POST", +"id": "aiplatform.publishers.models.generateContent", +"parameterOrder": [ +"model" +], +"parameters": { +"model": { +"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"location": "path", +"pattern": "^publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+model}:generateContent", +"request": { +"$ref": "GoogleCloudAiplatformV1GenerateContentRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1GenerateContentResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"get": { +"description": "Gets a Model Garden publisher model.", +"flatPath": "v1/publishers/{publishersId}/models/{modelsId}", +"httpMethod": "GET", +"id": "aiplatform.publishers.models.get", +"parameterOrder": [ +"name" +], +"parameters": { +"huggingFaceToken": { +"description": "Optional. Token used to access Hugging Face gated models.", +"location": "query", +"type": "string" +}, +"isHuggingFaceModel": { +"description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.", +"location": "query", +"type": "boolean" +}, +"languageCode": { +"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`", +"location": "path", +"pattern": "^publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "Optional. PublisherModel view specifying which fields to read.", +"enum": [ +"PUBLISHER_MODEL_VIEW_UNSPECIFIED", +"PUBLISHER_MODEL_VIEW_BASIC", +"PUBLISHER_MODEL_VIEW_FULL", +"PUBLISHER_MODEL_VERSION_VIEW_BASIC" +], +"enumDescriptions": [ +"The default / unset value. The API will default to the BASIC view.", +"Include basic metadata about the publisher model, but not the full contents.", +"Include everything.", +"Include: VersionId, ModelVersionExternalName, and SupportedActions." +], +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1PublisherModel" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"predict": { +"description": "", +"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:predict", +"httpMethod": "POST", +"id": "aiplatform.publishers.models.predict", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"location": "path", +"pattern": "^publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+endpoint}:predict", +"request": { +"$ref": "GoogleCloudAiplatformV1PredictRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1PredictResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"predictLongRunning": { +"description": "", +"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:predictLongRunning", +"httpMethod": "POST", +"id": "aiplatform.publishers.models.predictLongRunning", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", +"location": "path", +"pattern": "^publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+endpoint}:predictLongRunning", +"request": { +"$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"streamGenerateContent": { +"description": "Generate content with multimodal inputs with streaming support.", +"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent", +"httpMethod": "POST", +"id": "aiplatform.publishers.models.streamGenerateContent", +"parameterOrder": [ +"model" +], +"parameters": { +"model": { +"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"location": "path", +"pattern": "^publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+model}:streamGenerateContent", +"request": { +"$ref": "GoogleCloudAiplatformV1GenerateContentRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1GenerateContentResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +} +} +} +} +}, +"ragCorpora": { +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.ragCorpora.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^ragCorpora/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.ragCorpora.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^ragCorpora/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.ragCorpora.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^ragCorpora/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/ragCorpora/{ragCorporaId}/operations", +"httpMethod": "GET", +"id": "aiplatform.ragCorpora.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^ragCorpora/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.ragCorpora.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^ragCorpora/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"ragFiles": { +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.ragCorpora.ragFiles.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.ragCorpora.ragFiles.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.ragCorpora.ragFiles.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations", +"httpMethod": "GET", +"id": "aiplatform.ragCorpora.ragFiles.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.ragCorpora.ragFiles.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +}, +"ragEngineConfig": { +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/ragEngineConfig/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.ragEngineConfig.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^ragEngineConfig/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1/ragEngineConfig/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.ragEngineConfig.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^ragEngineConfig/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/ragEngineConfig/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.ragEngineConfig.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^ragEngineConfig/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/ragEngineConfig/operations", +"httpMethod": "GET", +"id": "aiplatform.ragEngineConfig.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^ragEngineConfig$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1/ragEngineConfig/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.ragEngineConfig.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^ragEngineConfig/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"reasoningEngines": { +"methods": { +"create": { +"description": "Creates a reasoning engine.", +"flatPath": "v1/reasoningEngines", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.create", +"parameterOrder": [], +"parameters": { +"parent": { +"description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`", +"location": "query", +"type": "string" +} +}, +"path": "v1/reasoningEngines", +"request": { +"$ref": "GoogleCloudAiplatformV1ReasoningEngine" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a reasoning engine.", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}", +"httpMethod": "DELETE", +"id": "aiplatform.reasoningEngines.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"force": { +"description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"executeCode": { +"description": "Executes code statelessly.", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}:executeCode", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.executeCode", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:executeCode", +"request": { +"$ref": "GoogleCloudAiplatformV1ExecuteCodeRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1ExecuteCodeResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a reasoning engine.", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1ReasoningEngine" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists reasoning engines in a location.", +"flatPath": "v1/reasoningEngines", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.list", +"parameterOrder": [], +"parameters": { +"filter": { +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The standard list page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`", +"location": "query", +"type": "string" +} +}, +"path": "v1/reasoningEngines", +"response": { +"$ref": "GoogleCloudAiplatformV1ListReasoningEnginesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a reasoning engine.", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}", +"httpMethod": "PATCH", +"id": "aiplatform.reasoningEngines.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Mask specifying which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1ReasoningEngine" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"query": { +"description": "Queries using a reasoning engine.", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}:query", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.query", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" } }, -"path": "v1/{+name}/operations", +"path": "v1/{+name}:query", +"request": { +"$ref": "GoogleCloudAiplatformV1QueryReasoningEngineRequest" +}, "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudAiplatformV1QueryReasoningEngineResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait", +"streamQuery": { +"description": "Streams queries using a reasoning engine.", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}:streamQuery", "httpMethod": "POST", -"id": "aiplatform.ragCorpora.operations.wait", +"id": "aiplatform.reasoningEngines.streamQuery", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to wait on.", +"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^ragCorpora/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" -}, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", -"location": "query", -"type": "string" } }, -"path": "v1/{+name}:wait", +"path": "v1/{+name}:streamQuery", +"request": { +"$ref": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest" +}, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleApiHttpBody" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } -} }, -"ragFiles": { +"resources": { +"memories": { "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.ragCorpora.ragFiles.operations.cancel", +"id": "aiplatform.reasoningEngines.memories.operations.cancel", "parameterOrder": [ "name" ], @@ -27952,7 +29042,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -27967,9 +29057,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.ragCorpora.ragFiles.operations.delete", +"id": "aiplatform.reasoningEngines.memories.operations.delete", "parameterOrder": [ "name" ], @@ -27977,7 +29067,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -27992,9 +29082,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.ragCorpora.ragFiles.operations.get", +"id": "aiplatform.reasoningEngines.memories.operations.get", "parameterOrder": [ "name" ], @@ -28002,7 +29092,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -28017,9 +29107,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations", "httpMethod": "GET", -"id": "aiplatform.ragCorpora.ragFiles.operations.list", +"id": "aiplatform.reasoningEngines.memories.operations.list", "parameterOrder": [ "name" ], @@ -28032,7 +29122,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", "required": true, "type": "string" }, @@ -28063,9 +29153,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.ragCorpora.ragFiles.operations.wait", +"id": "aiplatform.reasoningEngines.memories.operations.wait", "parameterOrder": [ "name" ], @@ -28073,7 +29163,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -28095,18 +29185,14 @@ } } } -} -} }, -"ragEngineConfig": { -"resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/ragEngineConfig/operations/{operationsId}:cancel", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.ragEngineConfig.operations.cancel", +"id": "aiplatform.reasoningEngines.operations.cancel", "parameterOrder": [ "name" ], @@ -28114,7 +29200,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^ragEngineConfig/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -28129,9 +29215,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/ragEngineConfig/operations/{operationsId}", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.ragEngineConfig.operations.delete", +"id": "aiplatform.reasoningEngines.operations.delete", "parameterOrder": [ "name" ], @@ -28139,7 +29225,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^ragEngineConfig/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -28154,9 +29240,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/ragEngineConfig/operations/{operationsId}", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.ragEngineConfig.operations.get", +"id": "aiplatform.reasoningEngines.operations.get", "parameterOrder": [ "name" ], @@ -28164,7 +29250,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^ragEngineConfig/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -28179,9 +29265,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/ragEngineConfig/operations", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations", "httpMethod": "GET", -"id": "aiplatform.ragEngineConfig.operations.list", +"id": "aiplatform.reasoningEngines.operations.list", "parameterOrder": [ "name" ], @@ -28194,7 +29280,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^ragEngineConfig$", +"pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" }, @@ -28225,9 +29311,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/ragEngineConfig/operations/{operationsId}:wait", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.ragEngineConfig.operations.wait", +"id": "aiplatform.reasoningEngines.operations.wait", "parameterOrder": [ "name" ], @@ -28235,7 +29321,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^ragEngineConfig/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -28255,240 +29341,155 @@ ] } } -} -} }, -"reasoningEngines": { +"runtimeRevisions": { "methods": { -"create": { -"description": "Creates a reasoning engine.", -"flatPath": "v1/reasoningEngines", +"query": { +"description": "Queries using a reasoning engine.", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:query", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.create", -"parameterOrder": [], -"parameters": { -"parent": { -"description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`", -"location": "query", -"type": "string" -} -}, -"path": "v1/reasoningEngines", -"request": { -"$ref": "GoogleCloudAiplatformV1ReasoningEngine" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Deletes a reasoning engine.", -"flatPath": "v1/reasoningEngines/{reasoningEnginesId}", -"httpMethod": "DELETE", -"id": "aiplatform.reasoningEngines.delete", +"id": "aiplatform.reasoningEngines.runtimeRevisions.query", "parameterOrder": [ "name" ], "parameters": { -"force": { -"description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.", -"location": "query", -"type": "boolean" -}, "name": { -"description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}", +"path": "v1/{+name}:query", +"request": { +"$ref": "GoogleCloudAiplatformV1QueryReasoningEngineRequest" +}, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1QueryReasoningEngineResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"executeCode": { -"description": "Executes code statelessly.", -"flatPath": "v1/reasoningEngines/{reasoningEnginesId}:executeCode", +"streamQuery": { +"description": "Streams queries using a reasoning engine.", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:streamQuery", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.executeCode", +"id": "aiplatform.reasoningEngines.runtimeRevisions.streamQuery", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:executeCode", +"path": "v1/{+name}:streamQuery", "request": { -"$ref": "GoogleCloudAiplatformV1ExecuteCodeRequest" +"$ref": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest" }, "response": { -"$ref": "GoogleCloudAiplatformV1ExecuteCodeResponse" +"$ref": "GoogleApiHttpBody" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -}, -"get": { -"description": "Gets a reasoning engine.", -"flatPath": "v1/reasoningEngines/{reasoningEnginesId}", -"httpMethod": "GET", -"id": "aiplatform.reasoningEngines.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", -"location": "path", -"pattern": "^reasoningEngines/[^/]+$", -"required": true, -"type": "string" } -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleCloudAiplatformV1ReasoningEngine" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists reasoning engines in a location.", -"flatPath": "v1/reasoningEngines", -"httpMethod": "GET", -"id": "aiplatform.reasoningEngines.list", -"parameterOrder": [], -"parameters": { -"filter": { -"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. The standard list page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`", -"location": "query", -"type": "string" } }, -"path": "v1/reasoningEngines", -"response": { -"$ref": "GoogleCloudAiplatformV1ListReasoningEnginesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"patch": { -"description": "Updates a reasoning engine.", -"flatPath": "v1/reasoningEngines/{reasoningEnginesId}", -"httpMethod": "PATCH", -"id": "aiplatform.reasoningEngines.patch", +"sandboxEnvironmentSnapshots": { +"methods": { +"delete": { +"description": "Deletes the specific SandboxEnvironmentSnapshot.", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}", +"httpMethod": "DELETE", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"description": "Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$", "required": true, "type": "string" -}, -"updateMask": { -"description": "Optional. Mask specifying which fields to update.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, "path": "v1/{+name}", -"request": { -"$ref": "GoogleCloudAiplatformV1ReasoningEngine" -}, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" -] -}, -"query": { -"description": "Queries using a reasoning engine.", -"flatPath": "v1/reasoningEngines/{reasoningEnginesId}:query", -"httpMethod": "POST", -"id": "aiplatform.reasoningEngines.query", +] +}, +"get": { +"description": "Gets details of the specific SandboxEnvironmentSnapshot.", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"description": "Required. The resource name of the sandbox environment snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:query", -"request": { -"$ref": "GoogleCloudAiplatformV1QueryReasoningEngineRequest" -}, +"path": "v1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1QueryReasoningEngineResponse" +"$ref": "GoogleCloudAiplatformV1SandboxEnvironmentSnapshot" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"streamQuery": { -"description": "Streams queries using a reasoning engine.", -"flatPath": "v1/reasoningEngines/{reasoningEnginesId}:streamQuery", -"httpMethod": "POST", -"id": "aiplatform.reasoningEngines.streamQuery", +"list": { +"description": "Lists SandboxEnvironmentSnapshots in a given reasoning engine.", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"filter": { +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", "pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:streamQuery", -"request": { -"$ref": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest" -}, +"path": "v1/{+parent}/sandboxEnvironmentSnapshots", "response": { -"$ref": "GoogleApiHttpBody" +"$ref": "GoogleCloudAiplatformV1ListSandboxEnvironmentSnapshotsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -28496,15 +29497,13 @@ } }, "resources": { -"memories": { -"resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:cancel", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.memories.operations.cancel", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.cancel", "parameterOrder": [ "name" ], @@ -28512,7 +29511,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -28527,9 +29526,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.reasoningEngines.memories.operations.delete", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.delete", "parameterOrder": [ "name" ], @@ -28537,7 +29536,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -28552,9 +29551,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.memories.operations.get", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.get", "parameterOrder": [ "name" ], @@ -28562,7 +29561,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -28575,57 +29574,11 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations", -"httpMethod": "GET", -"id": "aiplatform.reasoningEngines.memories.operations.list", -"parameterOrder": [ -"name" -], -"parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", -"type": "string" -}, -"name": { -"description": "The name of the operation's parent resource.", -"location": "path", -"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", -"required": true, -"type": "string" -}, -"pageSize": { -"description": "The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The standard list page token.", -"location": "query", -"type": "string" -}, -"returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1/{+name}/operations", -"response": { -"$ref": "GoogleLongrunningListOperationsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:wait", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.memories.operations.wait", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.wait", "parameterOrder": [ "name" ], @@ -28633,7 +29586,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -28656,124 +29609,201 @@ } } }, -"operations": { +"sandboxEnvironmentTemplates": { "methods": { -"cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel", +"create": { +"description": "Creates a SandboxEnvironmentTemplate in a given reasoning engine.", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.operations.cancel", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", +"parent": { +"description": "Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:cancel", +"path": "v1/{+parent}/sandboxEnvironmentTemplates", +"request": { +"$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplate" +}, "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", +"description": "Deletes the specific SandboxEnvironmentTemplate.", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}", "httpMethod": "DELETE", -"id": "aiplatform.reasoningEngines.operations.delete", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to be deleted.", +"description": "Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", +"description": "Gets details of the specific SandboxEnvironmentTemplate.", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.operations.get", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. The resource name of the sandbox environment template. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplate" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations", +"description": "Lists SandboxEnvironmentTemplates in a given reasoning engine.", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.operations.list", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { "filter": { -"description": "The standard list filter.", +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, -"name": { -"description": "The name of the operation's parent resource.", -"location": "path", -"pattern": "^reasoningEngines/[^/]+$", -"required": true, -"type": "string" -}, "pageSize": { -"description": "The standard list page size.", +"description": "Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token.", +"description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, -"returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", -"location": "query", -"type": "boolean" +"parent": { +"description": "Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" } }, -"path": "v1/{+name}/operations", +"path": "v1/{+parent}/sandboxEnvironmentTemplates", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudAiplatformV1ListSandboxEnvironmentTemplatesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -28781,9 +29811,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.operations.wait", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.wait", "parameterOrder": [ "name" ], @@ -28791,7 +29821,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -28811,6 +29841,8 @@ ] } } +} +} }, "sandboxEnvironments": { "methods": { @@ -28948,14 +29980,42 @@ "parent": { "description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/sandboxEnvironments", +"response": { +"$ref": "GoogleCloudAiplatformV1ListSandboxEnvironmentsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"snapshot": { +"description": "Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.", +"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:snapshot", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.sandboxEnvironments.snapshot", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/sandboxEnvironments", +"path": "v1/{+name}:snapshot", +"request": { +"$ref": "GoogleCloudAiplatformV1SandboxEnvironmentSnapshot" +}, "response": { -"$ref": "GoogleCloudAiplatformV1ListSandboxEnvironmentsResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -30865,7 +31925,7 @@ } } }, -"revision": "20260329", +"revision": "20260410", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { @@ -37481,6 +38541,28 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1EvaluationParserConfig": { +"description": "Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters.", +"id": "GoogleCloudAiplatformV1EvaluationParserConfig", +"properties": { +"customCodeParserConfig": { +"$ref": "GoogleCloudAiplatformV1EvaluationParserConfigCustomCodeParserConfig", +"description": "Optional. Use custom code to parse the LLM response." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1EvaluationParserConfigCustomCodeParserConfig": { +"description": "Configuration for parsing the LLM response using custom code.", +"id": "GoogleCloudAiplatformV1EvaluationParserConfigCustomCodeParserConfig", +"properties": { +"parsingFunction": { +"description": "Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { \"content\": {\"property\": {\"description\": \"The response is factual.\"}}, \"type\": \"FACTUALITY\", \"importance\": \"HIGH\" }, { \"content\": {\"property\": {\"description\": \"The response is fluent.\"}}, \"type\": \"FLUENCY\", \"importance\": \"MEDIUM\" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { \"score\": 0.8, \"explanation\": \"The model followed most instructions.\", \"rubric_verdicts\": [...] } ... code for result extraction and aggregation", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1EvaluationPrompt": { "description": "Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations.", "id": "GoogleCloudAiplatformV1EvaluationPrompt", @@ -37826,6 +38908,11 @@ "model": { "description": "Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string" +}, +"parallelism": { +"description": "Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used.", +"format": "int32", +"type": "integer" } }, "type": "object" @@ -41700,6 +42787,13 @@ "description": "Request message for MemoryBankService.GenerateMemories. Maximum size is 8 MB.", "id": "GoogleCloudAiplatformV1GenerateMemoriesRequest", "properties": { +"allowedTopics": { +"description": "Optional. Restricts memory generation to a subset of memory topics.", +"items": { +"$ref": "GoogleCloudAiplatformV1MemoryTopicId" +}, +"type": "array" +}, "directContentsSource": { "$ref": "GoogleCloudAiplatformV1GenerateMemoriesRequestDirectContentsSource", "description": "Defines a direct source of content as the source content from which to generate memories." @@ -43582,10 +44676,24 @@ "description": "An extracted memory that is the intermediate result before consolidation.", "id": "GoogleCloudAiplatformV1IntermediateExtractedMemory", "properties": { +"context": { +"description": "Output only. Represents the explanation of why the information was extracted from the source content.", +"readOnly": true, +"type": "string" +}, "fact": { -"description": "Output only. The fact of the extracted memory.", +"description": "Output only. Represents the fact of the extracted memory.", "readOnly": true, "type": "string" +}, +"structuredData": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Output only. Represents the structured value of the extracted memory.", +"readOnly": true, +"type": "object" } }, "type": "object" @@ -43708,6 +44816,10 @@ "$ref": "GoogleCloudAiplatformV1PredefinedMetricSpec", "description": "Dynamically generate rubrics using a predefined spec." }, +"resultParserConfig": { +"$ref": "GoogleCloudAiplatformV1EvaluationParserConfig", +"description": "Optional. The parser config for the metric result." +}, "rubricGenerationSpec": { "$ref": "GoogleCloudAiplatformV1RubricGenerationSpec", "description": "Dynamically generate rubrics using this specification." @@ -44627,6 +45739,42 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1ListSandboxEnvironmentSnapshotsResponse": { +"description": "Response message for SandboxEnvironmentService.ListSandboxEnvironmentSnapshots.", +"id": "GoogleCloudAiplatformV1ListSandboxEnvironmentSnapshotsResponse", +"properties": { +"nextPageToken": { +"description": "A token, which can be sent as ListSandboxEnvironmentSnapshotsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", +"type": "string" +}, +"sandboxEnvironmentSnapshots": { +"description": "The SandboxEnvironmentSnapshots matching the request.", +"items": { +"$ref": "GoogleCloudAiplatformV1SandboxEnvironmentSnapshot" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1ListSandboxEnvironmentTemplatesResponse": { +"description": "Response message for SandboxEnvironmentService.ListSandboxEnvironmentTemplates.", +"id": "GoogleCloudAiplatformV1ListSandboxEnvironmentTemplatesResponse", +"properties": { +"nextPageToken": { +"description": "A token, which can be sent as ListSandboxEnvironmentTemplatesRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", +"type": "string" +}, +"sandboxEnvironmentTemplates": { +"description": "The SandboxEnvironmentTemplates matching the request.", +"items": { +"$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplate" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1ListSandboxEnvironmentsResponse": { "description": "Response message for SandboxEnvironmentService.ListSandboxEnvironments.", "id": "GoogleCloudAiplatformV1ListSandboxEnvironmentsResponse", @@ -45108,45 +46256,45 @@ false "id": "GoogleCloudAiplatformV1Memory", "properties": { "createTime": { -"description": "Output only. Timestamp when this Memory was created.", +"description": "Output only. Represents the timestamp when this Memory was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "description": { -"description": "Optional. Description of the Memory.", +"description": "Optional. Represents the description of the Memory.", "type": "string" }, "disableMemoryRevisions": { -"description": "Optional. Input only. If true, no revision will be created for this request.", +"description": "Optional. Input only. Indicates whether no revision will be created for this request.", "type": "boolean" }, "displayName": { -"description": "Optional. Display name of the Memory.", +"description": "Optional. Represents the display name of the Memory.", "type": "string" }, "expireTime": { -"description": "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.", +"description": "Optional. Represents the 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.", "format": "google-datetime", "type": "string" }, "fact": { -"description": "Optional. Semantic knowledge extracted from the source content.", +"description": "Optional. Represents semantic knowledge extracted from the source content.", "type": "string" }, "metadata": { "additionalProperties": { "$ref": "GoogleCloudAiplatformV1MemoryMetadataValue" }, -"description": "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.", +"description": "Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.", "type": "object" }, "name": { -"description": "Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", +"description": "Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "type": "string" }, "revisionExpireTime": { -"description": "Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.", +"description": "Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.", "format": "google-datetime", "type": "string" }, @@ -45154,11 +46302,11 @@ false "additionalProperties": { "type": "string" }, -"description": "Optional. Input only. The labels to apply to the Memory Revision created as a result of this request.", +"description": "Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.", "type": "object" }, "revisionTtl": { -"description": "Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL.", +"description": "Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.", "format": "google-duration", "type": "string" }, @@ -45166,23 +46314,23 @@ false "additionalProperties": { "type": "string" }, -"description": "Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.", +"description": "Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.", "type": "object" }, "topics": { -"description": "Optional. The Topics of the Memory.", +"description": "Optional. Represents the Topics of the Memory.", "items": { "$ref": "GoogleCloudAiplatformV1MemoryTopicId" }, "type": "array" }, "ttl": { -"description": "Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.", +"description": "Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.", "format": "google-duration", "type": "string" }, "updateTime": { -"description": "Output only. Timestamp when this Memory was most recently updated.", +"description": "Output only. Represents the timestamp when this Memory was most recently updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -45191,33 +46339,37 @@ false "type": "object" }, "GoogleCloudAiplatformV1MemoryBankCustomizationConfig": { -"description": "Represents configuration for organizing memories for a particular scope.", +"description": "Represents configuration for organizing natural language memories for a particular scope.", "id": "GoogleCloudAiplatformV1MemoryBankCustomizationConfig", "properties": { "consolidationConfig": { "$ref": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigConsolidationConfig", "description": "Optional. Represents configuration for customizing how memories are consolidated together." }, +"disableNaturalLanguageMemories": { +"description": "Optional. Indicates whether natural language memory generation should be disabled for all requests. By default, natural language memory generation is enabled. Set this to `true` when you only want to generate structured memories.", +"type": "boolean" +}, "enableThirdPersonMemories": { -"description": "Optional. If true, then the memories will be generated in the third person (i.e. \"The user generates memories with Memory Bank.\"). By default, the memories will be generated in the first person (i.e. \"I generate memories with Memory Bank.\")", +"description": "Optional. Indicates whether the memories will be generated in the third person (i.e. \"The user generates memories with Memory Bank.\"). By default, the memories will be generated in the first person (i.e. \"I generate memories with Memory Bank.\")", "type": "boolean" }, "generateMemoriesExamples": { -"description": "Optional. Examples of how to generate memories for a particular scope.", +"description": "Optional. Provides examples of how to generate memories for a particular scope.", "items": { "$ref": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigGenerateMemoriesExample" }, "type": "array" }, "memoryTopics": { -"description": "Optional. Topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used.", +"description": "Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used.", "items": { "$ref": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigMemoryTopic" }, "type": "array" }, "scopeKeys": { -"description": "Optional. The scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank.", +"description": "Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank.", "items": { "type": "string" }, @@ -45231,7 +46383,7 @@ false "id": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigConsolidationConfig", "properties": { "revisionsPerCandidateCount": { -"description": "Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered.", +"description": "Optional. Represents the maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered.", "format": "int32", "type": "integer" } @@ -45247,7 +46399,7 @@ false "description": "A conversation source for the example." }, "generatedMemories": { -"description": "Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation.", +"description": "Optional. Represents the memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation.", "items": { "$ref": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigGenerateMemoriesExampleGeneratedMemory" }, @@ -45261,7 +46413,7 @@ false "id": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSource", "properties": { "events": { -"description": "Optional. The input conversation events for the example.", +"description": "Optional. Represents the input conversation events for the example.", "items": { "$ref": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceEvent" }, @@ -45276,7 +46428,7 @@ false "properties": { "content": { "$ref": "GoogleCloudAiplatformV1Content", -"description": "Required. The content of the event." +"description": "Required. Represents the content of the event." } }, "type": "object" @@ -45286,11 +46438,11 @@ false "id": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigGenerateMemoriesExampleGeneratedMemory", "properties": { "fact": { -"description": "Required. The fact to generate a memory from.", +"description": "Required. Represents the fact to generate a memory from.", "type": "string" }, "topics": { -"description": "Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = \"jargon\"` if the extracted memory is an example of memory extraction for the custom topic `jargon`.", +"description": "Optional. Represents the list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = \"jargon\"` if the extracted memory is an example of memory extraction for the custom topic `jargon`.", "items": { "$ref": "GoogleCloudAiplatformV1MemoryTopicId" }, @@ -45319,11 +46471,11 @@ false "id": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigMemoryTopicCustomMemoryTopic", "properties": { "description": { -"description": "Required. Description of the memory topic. This should explain what information should be extracted for this topic.", +"description": "Required. Represents the description of the memory topic. This should explain what information should be extracted for this topic.", "type": "string" }, "label": { -"description": "Required. The label of the topic.", +"description": "Required. Represents the label of the topic.", "type": "string" } }, @@ -45334,7 +46486,7 @@ false "id": "GoogleCloudAiplatformV1MemoryBankCustomizationConfigMemoryTopicManagedMemoryTopic", "properties": { "managedTopicEnum": { -"description": "Required. The managed topic.", +"description": "Required. Represents the managed topic.", "enum": [ "MANAGED_TOPIC_ENUM_UNSPECIFIED", "USER_PERSONAL_INFO", @@ -45343,11 +46495,11 @@ false "EXPLICIT_INSTRUCTIONS" ], "enumDescriptions": [ -"Unspecified topic. This value should not be used.", -"Significant personal information about the User like first names, relationships, hobbies, important dates.", -"Stated or implied likes, dislikes, preferred styles, or patterns.", -"Important milestones or conclusions within the dialogue.", -"Information that the user explicitly requested to remember or forget." +"Represents an unspecified topic. This value should not be used.", +"Represents significant personal information about the User like first names, relationships, hobbies, important dates.", +"Represents stated or implied likes, dislikes, preferred styles, or patterns.", +"Represents important milestones or conclusions within the dialogue.", +"Represents information that the user explicitly requested to remember or forget." ], "type": "string" } @@ -45359,7 +46511,7 @@ false "id": "GoogleCloudAiplatformV1MemoryConjunctionFilter", "properties": { "filters": { -"description": "Filters that will combined using AND logic.", +"description": "Represents filters that will be combined using AND logic.", "items": { "$ref": "GoogleCloudAiplatformV1MemoryFilter" }, @@ -45373,15 +46525,15 @@ false "id": "GoogleCloudAiplatformV1MemoryFilter", "properties": { "key": { -"description": "Key of the filter. For example, \"author\" would apply to `metadata` entries with the key \"author\".", +"description": "Represents the key of the filter. For example, \"author\" would apply to `metadata` entries with the key \"author\".", "type": "string" }, "negate": { -"description": "If true, the filter will be negated.", +"description": "Indicates whether the filter will be negated.", "type": "boolean" }, "op": { -"description": "Operator to apply to the filter. If not set, then EQUAL will be used.", +"description": "Represents the operator to apply to the filter. If not set, then EQUAL will be used.", "enum": [ "OPERATOR_UNSPECIFIED", "EQUAL", @@ -45389,7 +46541,7 @@ false "LESS_THAN" ], "enumDescriptions": [ -"Unspecified operator. Defaults to EQUAL.", +"Represents an unspecified operator. Defaults to EQUAL.", "Equal to.", "Greater than.", "Less than." @@ -45398,7 +46550,40 @@ false }, "value": { "$ref": "GoogleCloudAiplatformV1MemoryMetadataValue", -"description": "Value to compare to." +"description": "Represents the value to compare to." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1MemoryGenerationTriggerConfig": { +"description": "Represents configuration for triggering generation.", +"id": "GoogleCloudAiplatformV1MemoryGenerationTriggerConfig", +"properties": { +"generationRule": { +"$ref": "GoogleCloudAiplatformV1MemoryGenerationTriggerConfigGenerationTriggerRule", +"description": "Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1MemoryGenerationTriggerConfigGenerationTriggerRule": { +"description": "Represents the active rule that determines when to flush the buffer.", +"id": "GoogleCloudAiplatformV1MemoryGenerationTriggerConfigGenerationTriggerRule", +"properties": { +"eventCount": { +"description": "Optional. Specifies to trigger generation when the event count reaches this limit.", +"format": "int32", +"type": "integer" +}, +"fixedInterval": { +"description": "Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity.", +"format": "google-duration", +"type": "string" +}, +"idleDuration": { +"description": "Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity.", +"format": "google-duration", +"type": "string" } }, "type": "object" @@ -45408,20 +46593,20 @@ false "id": "GoogleCloudAiplatformV1MemoryMetadataValue", "properties": { "boolValue": { -"description": "Boolean value.", +"description": "Represents a boolean value.", "type": "boolean" }, "doubleValue": { -"description": "Double value.", +"description": "Represents a double value.", "format": "double", "type": "number" }, "stringValue": { -"description": "String value.", +"description": "Represents a string value.", "type": "string" }, "timestampValue": { -"description": "Timestamp value. When filtering on timestamp values, only the seconds field will be compared.", +"description": "Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.", "format": "google-datetime", "type": "string" } @@ -45433,19 +46618,19 @@ false "id": "GoogleCloudAiplatformV1MemoryRevision", "properties": { "createTime": { -"description": "Output only. Timestamp when this Memory Revision was created.", +"description": "Output only. Represents the timestamp when this Memory Revision was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "expireTime": { -"description": "Output only. Timestamp of when this resource is considered expired.", +"description": "Output only. Represents the timestamp of when this resource is considered expired.", "format": "google-datetime", "readOnly": true, "type": "string" }, "extractedMemories": { -"description": "Output only. The extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation.", +"description": "Output only. Represents the extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation.", "items": { "$ref": "GoogleCloudAiplatformV1IntermediateExtractedMemory" }, @@ -45453,7 +46638,7 @@ false "type": "array" }, "fact": { -"description": "Output only. The fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation.", +"description": "Output only. Represents the fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation.", "readOnly": true, "type": "string" }, @@ -45461,13 +46646,22 @@ false "additionalProperties": { "type": "string" }, -"description": "Output only. The labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`.", +"description": "Output only. Represents the labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`.", "readOnly": true, "type": "object" }, "name": { -"description": "Identifier. The resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}`", +"description": "Identifier. Represents the resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}`", "type": "string" +}, +"structuredData": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Output only. Represents the structured value of the memory at the time of revision creation.", +"readOnly": true, +"type": "object" } }, "type": "object" @@ -45477,11 +46671,11 @@ false "id": "GoogleCloudAiplatformV1MemoryTopicId", "properties": { "customMemoryTopicLabel": { -"description": "Optional. The custom memory topic label.", +"description": "Optional. Represents the custom memory topic label.", "type": "string" }, "managedMemoryTopic": { -"description": "Optional. The managed memory topic.", +"description": "Optional. Represents the managed memory topic.", "enum": [ "MANAGED_TOPIC_ENUM_UNSPECIFIED", "USER_PERSONAL_INFO", @@ -45490,11 +46684,11 @@ false "EXPLICIT_INSTRUCTIONS" ], "enumDescriptions": [ -"Unspecified topic. This value should not be used.", -"Significant personal information about the User like first names, relationships, hobbies, important dates.", -"Stated or implied likes, dislikes, preferred styles, or patterns.", -"Important milestones or conclusions within the dialogue.", -"Information that the user explicitly requested to remember or forget." +"Represents an unspecified topic. This value should not be used.", +"Represents significant personal information about the User like first names, relationships, hobbies, important dates.", +"Represents stated or implied likes, dislikes, preferred styles, or patterns.", +"Represents important milestones or conclusions within the dialogue.", +"Represents information that the user explicitly requested to remember or forget." ], "type": "string" } @@ -52493,8 +53687,12 @@ false "description": "Configuration for how to generate memories.", "id": "GoogleCloudAiplatformV1ReasoningEngineContextSpecMemoryBankConfigGenerationConfig", "properties": { +"generationTriggerConfig": { +"$ref": "GoogleCloudAiplatformV1MemoryGenerationTriggerConfig", +"description": "Optional. Specifies the default trigger configuration for generating memories using `IngestEvents`." +}, "model": { -"description": "Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`.", +"description": "Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`.", "type": "string" } }, @@ -53222,6 +54420,23 @@ false }, "type": "array" }, +"memoryTypes": { +"description": "Optional. Specifies the types of memories to retrieve. If this field is empty or not provided, the request will default to retrieving only memories of type `NATURAL_LANGUAGE_COLLECTION`. If populated, the request will retrieve memories matching any of the specified `MemoryType` values.", +"items": { +"enum": [ +"MEMORY_TYPE_UNSPECIFIED", +"NATURAL_LANGUAGE_COLLECTION", +"STRUCTURED_PROFILE" +], +"enumDescriptions": [ +"Represents an unspecified memory type. This value should not be used.", +"Indicates belonging to a collection of natural language memories.", +"Indicates belonging to a structured profile." +], +"type": "string" +}, +"type": "array" +}, "scope": { "additionalProperties": { "type": "string" @@ -54022,6 +55237,11 @@ false "readOnly": true, "type": "string" }, +"sandboxHostname": { +"description": "Output only. The hostname of the SandboxEnvironment.", +"readOnly": true, +"type": "string" +}, "sandboxInternalIp": { "description": "Output only. The internal IP address of the SandboxEnvironment.", "readOnly": true, @@ -54030,6 +55250,76 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1SandboxEnvironmentSnapshot": { +"description": "SandboxEnvironmentSnapshot is a snapshot of the SandboxEnvironment.", +"id": "GoogleCloudAiplatformV1SandboxEnvironmentSnapshot", +"properties": { +"createTime": { +"description": "Output only. The timestamp when this SandboxEnvironmentSnapshot was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Required. The display name of the SandboxEnvironmentSnapshot.", +"type": "string" +}, +"expireTime": { +"description": "Optional. Timestamp in UTC of when this SandboxEnvironmentSnapshot is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.", +"format": "google-datetime", +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`", +"type": "string" +}, +"owner": { +"description": "Optional. Owner information for this sandbox snapshot. Different owners will have isolations on snapshot storage and identity. If not set, snapshot will be created as the default owner.", +"type": "string" +}, +"parentSnapshot": { +"description": "Output only. The resource name of the parent SandboxEnvironmentSnapshot. Empty if this is a root Snapshot (the first snapshot from a newly created sandbox). Can be used to reconstruct the whole ancestry tree of snapshots.", +"readOnly": true, +"type": "string" +}, +"postSnapshotAction": { +"description": "Optional. Input only. Action to take on the source SandboxEnvironment after the snapshot is taken. This field is only used in CreateSandboxEnvironmentSnapshotRequest and it is not stored in the resource.", +"enum": [ +"POST_SNAPSHOT_ACTION_UNSPECIFIED", +"RUNNING", +"PAUSE" +], +"enumDescriptions": [ +"The default value. This value is unused.", +"Sandbox environment will continue to run after snapshot is taken.", +"Sandbox environment will be paused after snapshot is taken." +], +"type": "string" +}, +"sizeBytes": { +"description": "Optional. Output only. Size of the snapshot data in bytes.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"sourceSandboxEnvironment": { +"description": "Required. The resource name of the source SandboxEnvironment this snapshot was taken from.", +"type": "string" +}, +"ttl": { +"description": "Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.", +"format": "google-duration", +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when this SandboxEnvironment was most recently updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1SandboxEnvironmentSpec": { "description": "The specification of a SandboxEnvironment.", "id": "GoogleCloudAiplatformV1SandboxEnvironmentSpec", @@ -54074,6 +55364,177 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1SandboxEnvironmentTemplate": { +"description": "The specification of a SandboxEnvironmentTemplate. A SandboxEnvironmentTemplate defines a template for creating SandboxEnvironments.", +"id": "GoogleCloudAiplatformV1SandboxEnvironmentTemplate", +"properties": { +"createTime": { +"description": "Output only. The timestamp when this SandboxEnvironmentTemplate was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"customContainerEnvironment": { +"$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateCustomContainerEnvironment", +"description": "The sandbox environment for custom container workloads." +}, +"defaultContainerEnvironment": { +"$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateDefaultContainerEnvironment", +"description": "The sandbox environment for default container workloads." +}, +"displayName": { +"description": "Required. The display name of the SandboxEnvironmentTemplate.", +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`", +"type": "string" +}, +"state": { +"description": "Output only. The state of the sandbox environment template.", +"enum": [ +"UNSPECIFIED", +"PROVISIONING", +"ACTIVE", +"DEPROVISIONING", +"DELETED", +"FAILED" +], +"enumDescriptions": [ +"The default value. This value is unused.", +"Runtime resources are being allocated for the sandbox environment.", +"Sandbox runtime is ready for serving.", +"Sandbox runtime is halted, performing tear down tasks.", +"Sandbox has terminated with underlying runtime failure.", +"Sandbox has failed to provision." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"warmPoolConfig": { +"$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateWarmPoolConfig", +"description": "Optional. The configuration for the warm pool of this template." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1SandboxEnvironmentTemplateCustomContainerEnvironment": { +"description": "The customized sandbox runtime environment for BYOC.", +"id": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateCustomContainerEnvironment", +"properties": { +"customContainerSpec": { +"$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateCustomContainerSpec", +"description": "The specification of the custom container environment." +}, +"ports": { +"description": "Ports to expose from the container.", +"items": { +"$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateNetworkPort" +}, +"type": "array" +}, +"resources": { +"$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateResourceRequirements", +"description": "Resource requests and limits for the container." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1SandboxEnvironmentTemplateCustomContainerSpec": { +"description": "Specification for deploying from a custom container image.", +"id": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateCustomContainerSpec", +"properties": { +"imageUri": { +"description": "Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1SandboxEnvironmentTemplateDefaultContainerEnvironment": { +"description": "The default sandbox runtime environment for default container workloads.", +"id": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateDefaultContainerEnvironment", +"properties": { +"defaultContainerCategory": { +"description": "Required. The category of the default container image.", +"enum": [ +"DEFAULT_CONTAINER_CATEGORY_UNSPECIFIED", +"DEFAULT_CONTAINER_CATEGORY_COMPUTER_USE" +], +"enumDescriptions": [ +"The default value. This value is unused.", +"The default container image for Computer Use." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1SandboxEnvironmentTemplateNetworkPort": { +"description": "Represents a network port in a container.", +"id": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateNetworkPort", +"properties": { +"port": { +"description": "Optional. Port number to expose. This must be a valid port number, between 1 and 65535.", +"format": "int32", +"type": "integer" +}, +"protocol": { +"description": "Optional. Protocol for port. Defaults to TCP if not specified.", +"enum": [ +"PROTOCOL_UNSPECIFIED", +"TCP", +"UDP" +], +"enumDescriptions": [ +"Unspecified protocol. Defaults to TCP.", +"TCP protocol.", +"UDP protocol." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1SandboxEnvironmentTemplateResourceRequirements": { +"description": "Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template.", +"id": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateResourceRequirements", +"properties": { +"limits": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., \"cpu\", \"memory\"). Values are quantities (e.g., \"500m\", \"1Gi\").", +"type": "object" +}, +"requests": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The requested amounts of compute resources. Keys are resource names (e.g., \"cpu\", \"memory\"). Values are quantities (e.g., \"250m\", \"512Mi\").", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1SandboxEnvironmentTemplateWarmPoolConfig": { +"description": "Configuration for a warm pool of sandbox instances.", +"id": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateWarmPoolConfig", +"properties": { +"targetInstanceCount": { +"description": "Optional. The target number of pre-warmed instances to maintain.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1SavedQuery": { "description": "A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.", "id": "GoogleCloudAiplatformV1SavedQuery", diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index ae0716e057..bb02102e4d 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -7684,6 +7684,166 @@ } } }, +"onlineEvaluators": { +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.onlineEvaluators.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.onlineEvaluators.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.onlineEvaluators.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations", +"httpMethod": "GET", +"id": "aiplatform.onlineEvaluators.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^onlineEvaluators/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.onlineEvaluators.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "operations": { "methods": { "cancel": { @@ -25976,6 +26136,164 @@ "https://www.googleapis.com/auth/cloud-platform" ] } +}, +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.onlineEvaluators.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.onlineEvaluators.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.onlineEvaluators.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.onlineEvaluators.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.onlineEvaluators.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} } }, "operations": { @@ -29728,7 +30046,7 @@ ], "parameters": { "a2aTaskId": { -"description": "Required. User-defined ID of the A2aTask. This ID must be unique within the ReasoningEngine.", +"description": "Required. User-defined ID of the A2aTask. This ID must be unique within the ReasoningEngine. It must be 1-63 characters, start with a lowercase letter or number, end with a lowercase letter or number, and only contain lowercase letters, numbers, and hyphens [AIP-122](https://google.aip.dev/122). Starting with a number is allowed for compatibility with the auto-generated UUID from A2A SDK.", "location": "query", "type": "string" }, @@ -30288,6 +30606,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"ingestEvents": { +"description": "Ingests events for a Memory Bank.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:ingestEvents", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.memories.ingestEvents", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/memories:ingestEvents", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1IngestEventsRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "List Memories.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories", @@ -30344,7 +30690,7 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", +"description": "Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$", "required": true, @@ -30424,6 +30770,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"retrieveProfiles": { +"description": "Retrieves profiles.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:retrieveProfiles", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.memories.retrieveProfiles", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the ReasoningEngine to retrieve profiles from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/memories:retrieveProfiles", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1RetrieveProfilesRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1RetrieveProfilesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "rollback": { "description": "Rollback Memory to a specific revision.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}:rollback", @@ -30839,309 +31213,279 @@ } }, "runtimeRevisions": { -"resources": { -"operations": { "methods": { -"cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}:cancel", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.cancel", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}:cancel", -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}", +"description": "Deletes a reasoning engine revision.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.delete", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to be deleted.", +"description": "Required. The name of the ReasoningEngineRuntimeRevision resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/runtimeRevisions/{runtime_revision}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}", +"description": "Gets a reasoning engine runtime revision.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.get", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. The name of the ReasoningEngineRuntimeRevision resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/runtimeRevisions/{runtimeRevision}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineRuntimeRevision" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations", +"description": "Lists runtime revisions in a reasoning engine.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions", "httpMethod": "GET", -"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.list", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { "filter": { -"description": "The standard list filter.", +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, -"name": { -"description": "The name of the operation's parent resource.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", -"required": true, -"type": "string" -}, "pageSize": { -"description": "The standard list page size.", +"description": "Optional. The maximum number of ReasoningEngineRuntimeRevisions to return. The service may return fewer than this value. If unspecified, at most 50 revisions will be returned. The maximum value is 100; values above 100 will be coerced to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token.", +"description": "Optional. The standard list page token.", "location": "query", "type": "string" }, -"returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", -"location": "query", -"type": "boolean" +"parent": { +"description": "Required. The resource name of the ReasoningEngine to list the ReasoningEngineRuntimeRevisions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", +"required": true, +"type": "string" } }, -"path": "v1beta1/{+name}/operations", +"path": "v1beta1/{+parent}/runtimeRevisions", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudAiplatformV1beta1ListReasoningEngineRuntimeRevisionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}:wait", +"query": { +"description": "Queries using a reasoning engine.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:query", "httpMethod": "POST", -"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.wait", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.query", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to wait on.", +"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" -}, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", -"location": "query", -"type": "string" } }, -"path": "v1beta1/{+name}:wait", +"path": "v1beta1/{+name}:query", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineRequest" +}, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} }, -"sandboxEnvironments": { -"methods": { -"create": { -"description": "Creates a SandboxEnvironment in a given reasoning engine.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", +"streamQuery": { +"description": "Streams queries using a reasoning engine.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:streamQuery", "httpMethod": "POST", -"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.create", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.streamQuery", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.", +"name": { +"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/sandboxEnvironments", +"path": "v1beta1/{+name}:streamQuery", "request": { -"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment" +"$ref": "GoogleCloudAiplatformV1beta1StreamQueryReasoningEngineRequest" }, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleApiHttpBody" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} }, -"delete": { -"description": "Deletes the specific SandboxEnvironment.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", -"httpMethod": "DELETE", -"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.delete", +"resources": { +"a2a": { +"methods": { +"card": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/card", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.card", "parameterOrder": [ -"name" +"name", +"a2aEndpoint" ], "parameters": { -"name": { -"description": "Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", +"pattern": "^card$", "required": true, "type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" }, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" }, -"execute": { -"description": "Executes using a sandbox environment.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:execute", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.execute", -"parameterOrder": [ -"name" -], -"parameters": { "name": { -"description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}:execute", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentRequest" -}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentResponse" +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"get": { -"description": "Gets details of the specific SandboxEnvironment.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", +"extendedAgentCard": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/extendedAgentCard", "httpMethod": "GET", -"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.get", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.extendedAgentCard", "parameterOrder": [ -"name" +"name", +"a2aEndpoint" ], "parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^extendedAgentCard$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, "name": { -"description": "Required. The resource name of the sandbox environment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}", +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment" +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"list": { -"description": "Lists SandboxEnvironments in a given reasoning engine.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", +"tasks": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks", "httpMethod": "GET", -"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.list", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks", "parameterOrder": [ -"parent" +"name", +"a2aEndpoint" ], "parameters": { -"filter": { -"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", -"location": "query", +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^tasks$", +"required": true, "type": "string" }, -"pageSize": { -"description": "Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page.", +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query", "type": "string" }, -"parent": { -"description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/sandboxEnvironments", +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentsResponse" +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -31149,416 +31493,749 @@ } }, "resources": { -"operations": { +"message": { "methods": { -"cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:cancel", +"send": { +"description": "Send post request for reasoning engine instance via the A2A post protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/message:send", "httpMethod": "POST", -"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.cancel", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.message.send", "parameterOrder": [ -"name" +"name", +"a2aEndpoint" ], "parameters": { +"a2aEndpoint": { +"description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", +"location": "path", +"pattern": "^message$", +"required": true, +"type": "string" +}, "name": { -"description": "The name of the operation resource to be cancelled.", +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}:cancel", +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send", +"request": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, "response": { -"$ref": "GoogleProtobufEmpty" +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", -"httpMethod": "DELETE", -"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.delete", +"stream": { +"description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/message:stream", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.message.stream", "parameterOrder": [ -"name" +"name", +"a2aEndpoint" ], "parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.", +"location": "path", +"pattern": "^message$", +"required": true, +"type": "string" +}, "name": { -"description": "The name of the operation resource to be deleted.", +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}", +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream", +"request": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleApiHttpBody" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} }, -"get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", +"tasks": { +"methods": { +"a2aGetReasoningEngine": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.get", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.a2aGetReasoningEngine", "parameterOrder": [ -"name" +"name", +"a2aEndpoint" ], "parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^tasks/[^/]+$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, "name": { -"description": "The name of the operation resource.", +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}", +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "response": { -"$ref": "GoogleLongrunningOperation" +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.list", +"cancel": { +"description": "Send post request for reasoning engine instance via the A2A post protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.cancel", "parameterOrder": [ -"name" +"name", +"a2aEndpoint" ], "parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", +"a2aEndpoint": { +"description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", +"location": "path", +"pattern": "^tasks/[^/]+$", +"required": true, "type": "string" }, "name": { -"description": "The name of the operation's parent resource.", +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" +} }, -"pageSize": { -"description": "The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The standard list page token.", -"location": "query", -"type": "string" +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel", +"request": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" }, -"returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", -"location": "query", -"type": "boolean" -} +"type": "object" }, -"path": "v1beta1/{+name}/operations", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:wait", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.wait", +"pushNotificationConfigs": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}/pushNotificationConfigs", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.pushNotificationConfigs", "parameterOrder": [ -"name" +"name", +"a2aEndpoint" ], "parameters": { -"name": { -"description": "The name of the operation resource to wait on.", +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", +"pattern": "^tasks/[^/]+/pushNotificationConfigs$", "required": true, "type": "string" }, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query", "type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", +"required": true, +"type": "string" } }, -"path": "v1beta1/{+name}:wait", +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "response": { -"$ref": "GoogleLongrunningOperation" +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} }, -"sessions": { -"methods": { -"appendEvent": { -"description": "Appends an event to a given session.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.appendEvent", +"subscribe": { +"description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}:subscribe", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.subscribe", "parameterOrder": [ -"name" +"name", +"a2aEndpoint" ], "parameters": { -"name": { -"description": "Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", +"pattern": "^tasks/[^/]+$", "required": true, "type": "string" -} }, -"path": "v1beta1/{+name}:appendEvent", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1SessionEvent" +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", +"required": true, +"type": "string" +} }, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe", "response": { -"$ref": "GoogleCloudAiplatformV1beta1AppendEventResponse" +"$ref": "GoogleApiHttpBody" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} }, -"create": { -"description": "Creates a new Session.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.create", +"resources": { +"pushNotificationConfigs": { +"methods": { +"a2aGetReasoningEngine": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.tasks.pushNotificationConfigs.a2aGetReasoningEngine", "parameterOrder": [ -"parent" +"name", +"a2aEndpoint" ], "parameters": { -"parent": { -"description": "Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", +"pattern": "^tasks/[^/]+/pushNotificationConfigs/[^/]+$", "required": true, "type": "string" }, -"sessionId": { -"description": "Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first and last characters must be a letter or number.", +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query", "type": "string" -} }, -"path": "v1beta1/{+parent}/sessions", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1Session" +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", +"required": true, +"type": "string" +} }, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "response": { -"$ref": "GoogleLongrunningOperation" +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} +} +} }, -"delete": { -"description": "Deletes details of the specific Session.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", -"httpMethod": "DELETE", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.delete", +"v1": { +"methods": { +"card": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/card", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.card", "parameterOrder": [ -"name" +"name", +"a2aEndpoint" ], "parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^v1/card$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, "name": { -"description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}", +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "response": { -"$ref": "GoogleLongrunningOperation" +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"get": { -"description": "Gets details of the specific Session.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", +"extendedAgentCard": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/extendedAgentCard", "httpMethod": "GET", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.get", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.extendedAgentCard", "parameterOrder": [ -"name" +"name", +"a2aEndpoint" ], "parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^v1/extendedAgentCard$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, "name": { -"description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}", +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1Session" +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"list": { -"description": "Lists Sessions in a given reasoning engine.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", +"tasks": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks", "httpMethod": "GET", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.list", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks", "parameterOrder": [ -"parent" +"name", +"a2aEndpoint" ], "parameters": { -"filter": { -"description": "Optional. The standard list filter. Supported fields: * `display_name` * `user_id` * `labels` Example: `display_name=\"abc\"`, `user_id=\"123\"`, `labels.key=\"value\"`.", -"location": "query", +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^v1/tasks$", +"required": true, "type": "string" }, -"orderBy": { -"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query", "type": "string" }, -"pageSize": { -"description": "Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.", -"format": "int32", -"location": "query", -"type": "integer" +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", +"required": true, +"type": "string" +} }, -"pageToken": { -"description": "Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.", -"location": "query", +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"message": { +"methods": { +"send": { +"description": "Send post request for reasoning engine instance via the A2A post protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/message:send", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.message.send", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", +"location": "path", +"pattern": "^v1/message$", +"required": true, "type": "string" }, -"parent": { -"description": "Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/sessions", +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send", +"request": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, "response": { -"$ref": "GoogleCloudAiplatformV1beta1ListSessionsResponse" +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"patch": { -"description": "Updates the specific Session.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", -"httpMethod": "PATCH", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.patch", +"stream": { +"description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/message:stream", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.message.stream", "parameterOrder": [ -"name" +"name", +"a2aEndpoint" ], "parameters": { -"name": { -"description": "Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.", +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", +"pattern": "^v1/message$", "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", +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", +"required": true, "type": "string" } }, -"path": "v1beta1/{+name}", +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream", "request": { -"$ref": "GoogleCloudAiplatformV1beta1Session" +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1Session" +"$ref": "GoogleApiHttpBody" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } +} }, -"resources": { -"events": { +"tasks": { "methods": { -"list": { -"description": "Lists Events in a given session.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events", +"a2aGetReasoningEngine": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.events.list", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.a2aGetReasoningEngine", "parameterOrder": [ -"parent" +"name", +"a2aEndpoint" ], "parameters": { -"filter": { -"description": "Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp>=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).", -"location": "query", +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^v1/tasks/[^/]+$", +"required": true, "type": "string" }, -"orderBy": { -"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`.", +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query", "type": "string" }, -"pageSize": { -"description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.", -"format": "int32", +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"cancel": { +"description": "Send post request for reasoning engine instance via the A2A post protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.cancel", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", +"location": "path", +"pattern": "^v1/tasks/[^/]+$", +"required": true, +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel", +"request": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"pushNotificationConfigs": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.pushNotificationConfigs", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^v1/tasks/[^/]+/pushNotificationConfigs$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query", -"type": "integer" +"type": "string" }, -"pageToken": { -"description": "Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.", +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"subscribe": { +"description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}:subscribe", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.subscribe", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.", +"location": "path", +"pattern": "^v1/tasks/[^/]+$", +"required": true, +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe", +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"pushNotificationConfigs": { +"methods": { +"a2aGetReasoningEngine": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^v1/tasks/[^/]+/pushNotificationConfigs/[^/]+$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", "location": "query", "type": "string" }, -"parent": { -"description": "Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/events", +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1ListEventsResponse" +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } +} +} +} +} +} +} }, "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.cancel", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.cancel", "parameterOrder": [ "name" ], @@ -31566,7 +32243,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -31581,9 +32258,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.delete", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.delete", "parameterOrder": [ "name" ], @@ -31591,7 +32268,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -31606,9 +32283,9 @@ }, "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.get", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.get", "parameterOrder": [ "name" ], @@ -31616,7 +32293,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -31631,9 +32308,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.list", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.list", "parameterOrder": [ "name" ], @@ -31646,7 +32323,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" }, @@ -31677,9 +32354,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.wait", +"id": "aiplatform.projects.locations.reasoningEngines.runtimeRevisions.operations.wait", "parameterOrder": [ "name" ], @@ -31687,7 +32364,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -31709,220 +32386,95 @@ } } } -} -} }, -"schedules": { +"sandboxEnvironmentSnapshots": { "methods": { -"create": { -"description": "Creates a Schedule.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.schedules.create", +"delete": { +"description": "Deletes the specific SandboxEnvironmentSnapshot.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.delete", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The resource name of the Location to create the Schedule in. Format: `projects/{project}/locations/{location}`", +"name": { +"description": "Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/schedules", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1Schedule" -}, +"path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1Schedule" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Deletes a Schedule.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", -"httpMethod": "DELETE", -"id": "aiplatform.projects.locations.schedules.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the Schedule resource to be deleted. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets a Schedule.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", +"description": "Gets details of the specific SandboxEnvironmentSnapshot.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.schedules.get", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the Schedule resource. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", +"description": "Required. The resource name of the sandbox environment snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1Schedule" +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSnapshot" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists Schedules in a Location.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules", +"description": "Lists SandboxEnvironmentSnapshots in a given reasoning engine.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots", "httpMethod": "GET", -"id": "aiplatform.projects.locations.schedules.list", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { -"description": "Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state=\"ACTIVE\" AND display_name:\"my_schedule_*\"` * `NOT display_name=\"my_schedule\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `end_time>\"2021-05-18T00:00:00Z\" OR NOT end_time:*` * `create_pipeline_job_request:*`", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "A comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple order_by fields provided. For example, using \"create_time desc, end_time\" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time`", +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "pageSize": { -"description": "The standard list page size. Default to 100 if not specified.", +"description": "Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.", +"description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource name of the Location to list the Schedules from. Format: `projects/{project}/locations/{location}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+parent}/schedules", -"response": { -"$ref": "GoogleCloudAiplatformV1beta1ListSchedulesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"patch": { -"description": "Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", -"httpMethod": "PATCH", -"id": "aiplatform.projects.locations.schedules.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Immutable. The resource name of the Schedule.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", -"required": true, -"type": "string" -}, -"updateMask": { -"description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1Schedule" -}, -"response": { -"$ref": "GoogleCloudAiplatformV1beta1Schedule" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"pause": { -"description": "Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.schedules.pause", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the Schedule resource to be paused. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}:pause", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1PauseScheduleRequest" -}, -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"resume": { -"description": "Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.schedules.resume", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the Schedule resource to be resumed. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", +"description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}:resume", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1ResumeScheduleRequest" -}, +"path": "v1beta1/{+parent}/sandboxEnvironmentSnapshots", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentSnapshotsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -31934,9 +32486,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.schedules.operations.cancel", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.cancel", "parameterOrder": [ "name" ], @@ -31944,7 +32496,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -31959,9 +32511,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.schedules.operations.delete", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.delete", "parameterOrder": [ "name" ], @@ -31969,7 +32521,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -31984,9 +32536,9 @@ }, "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.schedules.operations.get", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.get", "parameterOrder": [ "name" ], @@ -31994,7 +32546,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -32009,9 +32561,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.schedules.operations.list", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.list", "parameterOrder": [ "name" ], @@ -32024,7 +32576,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$", "required": true, "type": "string" }, @@ -32055,9 +32607,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.projects.locations.schedules.operations.wait", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.wait", "parameterOrder": [ "name" ], @@ -32065,7 +32617,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -32088,175 +32640,161 @@ } } }, -"semanticGovernancePolicies": { -"resources": { -"operations": { +"sandboxEnvironmentTemplates": { "methods": { -"cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:cancel", +"create": { +"description": "Creates a SandboxEnvironmentTemplate in a given reasoning engine.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates", "httpMethod": "POST", -"id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.cancel", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", +"parent": { +"description": "Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}:cancel", +"path": "v1beta1/{+parent}/sandboxEnvironmentTemplates", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplate" +}, "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}", +"description": "Deletes the specific SandboxEnvironmentTemplate.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.delete", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to be deleted.", +"description": "Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}", +"description": "Gets details of the specific SandboxEnvironmentTemplate.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.get", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. The resource name of the sandbox environment template. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplate" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations", +"description": "Lists SandboxEnvironmentTemplates in a given reasoning engine.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates", "httpMethod": "GET", -"id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.list", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { "filter": { -"description": "The standard list filter.", +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, -"name": { -"description": "The name of the operation's parent resource.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$", -"required": true, -"type": "string" -}, "pageSize": { -"description": "The standard list page size.", +"description": "Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token.", +"description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, -"returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", -"location": "query", -"type": "boolean" +"parent": { +"description": "Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", +"required": true, +"type": "string" } }, -"path": "v1beta1/{+name}/operations", +"path": "v1beta1/{+parent}/sandboxEnvironmentTemplates", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentTemplatesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} }, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:wait", +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.wait", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to wait on.", +"description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" -}, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", -"location": "query", -"type": "string" } }, -"path": "v1beta1/{+name}:wait", +"path": "v1beta1/{+name}:cancel", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} }, -"solvers": { -"resources": { -"operations": { -"methods": { "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.solvers.operations.delete", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.delete", "parameterOrder": [ "name" ], @@ -32264,7 +32802,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -32279,9 +32817,9 @@ }, "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.solvers.operations.get", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.get", "parameterOrder": [ "name" ], @@ -32289,7 +32827,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -32304,9 +32842,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.solvers.operations.list", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.list", "parameterOrder": [ "name" ], @@ -32319,7 +32857,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$", "required": true, "type": "string" }, @@ -32347,33 +32885,64 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } } } }, -"specialistPools": { +"sandboxEnvironments": { "methods": { "create": { -"description": "Creates a SpecialistPool.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools", +"description": "Creates a SandboxEnvironment in a given reasoning engine.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", "httpMethod": "POST", -"id": "aiplatform.projects.locations.specialistPools.create", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The parent Project name for the new SpecialistPool. The form is `projects/{project}/locations/{location}`.", +"description": "Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/specialistPools", +"path": "v1beta1/{+parent}/sandboxEnvironments", "request": { -"$ref": "GoogleCloudAiplatformV1beta1SpecialistPool" +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -32383,23 +32952,18 @@ ] }, "delete": { -"description": "Deletes a SpecialistPool as well as all Specialists in the pool.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", +"description": "Deletes the specific SandboxEnvironment.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.specialistPools.delete", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.delete", "parameterOrder": [ "name" ], "parameters": { -"force": { -"description": "If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.)", -"location": "query", -"type": "boolean" -}, "name": { -"description": "Required. The resource name of the SpecialistPool to delete. Format: `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`", +"description": "Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "required": true, "type": "string" } @@ -32412,99 +32976,120 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"execute": { +"description": "Executes using a sandbox environment.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:execute", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.execute", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:execute", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { -"description": "Gets a SpecialistPool.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", +"description": "Gets details of the specific SandboxEnvironment.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.specialistPools.get", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.", +"description": "Required. The resource name of the sandbox environment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1SpecialistPool" +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists SpecialistPools in a Location.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools", +"description": "Lists SandboxEnvironments in a given reasoning engine.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments", "httpMethod": "GET", -"id": "aiplatform.projects.locations.specialistPools.list", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.list", "parameterOrder": [ "parent" ], "parameters": { +"filter": { +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, "pageSize": { -"description": "The standard list page size.", +"description": "Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty.", +"description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The name of the SpecialistPool's parent resource. Format: `projects/{project}/locations/{location}`", +"description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" -}, -"readMask": { -"description": "Mask specifying which fields to read. FieldMask represents a set of", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, -"path": "v1beta1/{+parent}/specialistPools", +"path": "v1beta1/{+parent}/sandboxEnvironments", "response": { -"$ref": "GoogleCloudAiplatformV1beta1ListSpecialistPoolsResponse" +"$ref": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"patch": { -"description": "Updates a SpecialistPool.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", -"httpMethod": "PATCH", -"id": "aiplatform.projects.locations.specialistPools.patch", +"snapshot": { +"description": "Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:snapshot", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.snapshot", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The resource name of the SpecialistPool.", +"description": "Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "required": true, "type": "string" -}, -"updateMask": { -"description": "Required. The update mask applies to the resource.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, -"path": "v1beta1/{+name}", +"path": "v1beta1/{+name}:snapshot", "request": { -"$ref": "GoogleCloudAiplatformV1beta1SpecialistPool" +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSnapshot" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -32519,9 +33104,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.specialistPools.operations.cancel", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.cancel", "parameterOrder": [ "name" ], @@ -32529,7 +33114,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -32544,9 +33129,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.specialistPools.operations.delete", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.delete", "parameterOrder": [ "name" ], @@ -32554,7 +33139,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -32569,9 +33154,9 @@ }, "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.specialistPools.operations.get", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.get", "parameterOrder": [ "name" ], @@ -32579,7 +33164,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -32594,9 +33179,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.specialistPools.operations.list", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.list", "parameterOrder": [ "name" ], @@ -32609,7 +33194,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", "required": true, "type": "string" }, @@ -32640,9 +33225,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.projects.locations.specialistPools.operations.wait", +"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.wait", "parameterOrder": [ "name" ], @@ -32650,7 +33235,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -32673,145 +33258,194 @@ } } }, -"studies": { +"sessions": { "methods": { +"appendEvent": { +"description": "Appends an event to a given session.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.appendEvent", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:appendEvent", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1SessionEvent" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1AppendEventResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "create": { -"description": "Creates a Study. A resource name will be generated after creation of the Study.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies", +"description": "Creates a new Session.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", "httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.create", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`", +"description": "Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" +}, +"sessionId": { +"description": "Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first and last characters must be a letter or number.", +"location": "query", +"type": "string" } }, -"path": "v1beta1/{+parent}/studies", +"path": "v1beta1/{+parent}/sessions", "request": { -"$ref": "GoogleCloudAiplatformV1beta1Study" +"$ref": "GoogleCloudAiplatformV1beta1Session" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1Study" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a Study.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", +"description": "Deletes details of the specific Session.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.studies.delete", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the Study resource to be deleted. Format: `projects/{project}/locations/{location}/studies/{study}`", +"description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets a Study by name.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", +"description": "Gets details of the specific Session.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.studies.get", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the Study resource. Format: `projects/{project}/locations/{location}/studies/{study}`", +"description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1Study" +"$ref": "GoogleCloudAiplatformV1beta1Session" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists all the studies in a region for an associated project.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies", +"description": "Lists Sessions in a given reasoning engine.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions", "httpMethod": "GET", -"id": "aiplatform.projects.locations.studies.list", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.list", "parameterOrder": [ "parent" ], "parameters": { -"pageSize": { -"description": "Optional. The maximum number of studies to return per \"page\" of results. If unspecified, service will pick an appropriate default.", -"format": "int32", +"filter": { +"description": "Optional. The standard list filter. Supported fields: * `display_name` * `user_id` * `labels` Example: `display_name=\"abc\"`, `user_id=\"123\"`, `labels.key=\"value\"`.", "location": "query", -"type": "integer" +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.", +"format": "int32", +"location": "query", +"type": "integer" }, "pageToken": { -"description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", +"description": "Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource name of the Location to list the Study from. Format: `projects/{project}/locations/{location}`", +"description": "Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/studies", +"path": "v1beta1/{+parent}/sessions", "response": { -"$ref": "GoogleCloudAiplatformV1beta1ListStudiesResponse" +"$ref": "GoogleCloudAiplatformV1beta1ListSessionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"lookup": { -"description": "Looks a study up using the user-defined display_name field instead of the fully qualified resource name.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies:lookup", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.lookup", +"patch": { +"description": "Updates the specific Session.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.patch", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The resource name of the Location to get the Study from. Format: `projects/{project}/locations/{location}`", +"name": { +"description": "Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "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/{+parent}/studies:lookup", +"path": "v1beta1/{+name}", "request": { -"$ref": "GoogleCloudAiplatformV1beta1LookupStudyRequest" +"$ref": "GoogleCloudAiplatformV1beta1Session" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1Study" +"$ref": "GoogleCloudAiplatformV1beta1Session" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -32819,13 +33453,63 @@ } }, "resources": { +"events": { +"methods": { +"list": { +"description": "Lists Events in a given session.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.events.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp>=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/events", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ListEventsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.operations.cancel", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.cancel", "parameterOrder": [ "name" ], @@ -32833,7 +33517,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -32848,9 +33532,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.studies.operations.delete", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.delete", "parameterOrder": [ "name" ], @@ -32858,7 +33542,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -32873,9 +33557,9 @@ }, "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.studies.operations.get", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.get", "parameterOrder": [ "name" ], @@ -32883,7 +33567,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -32898,9 +33582,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.studies.operations.list", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.list", "parameterOrder": [ "name" ], @@ -32913,7 +33597,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$", "required": true, "type": "string" }, @@ -32944,9 +33628,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.operations.wait", +"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.wait", "parameterOrder": [ "name" ], @@ -32954,7 +33638,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -32974,286 +33658,222 @@ ] } } -}, -"trials": { -"methods": { -"addTrialMeasurement": { -"description": "Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.trials.addTrialMeasurement", -"parameterOrder": [ -"trialName" -], -"parameters": { -"trialName": { -"description": "Required. The name of the trial to add measurement. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", -"required": true, -"type": "string" } -}, -"path": "v1beta1/{+trialName}:addTrialMeasurement", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1AddTrialMeasurementRequest" -}, -"response": { -"$ref": "GoogleCloudAiplatformV1beta1Trial" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"checkTrialEarlyStoppingState": { -"description": "Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState", -"parameterOrder": [ -"trialName" -], -"parameters": { -"trialName": { -"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", -"required": true, -"type": "string" } -}, -"path": "v1beta1/{+trialName}:checkTrialEarlyStoppingState", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateRequest" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"complete": { -"description": "Marks a Trial as complete.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.trials.complete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", -"required": true, -"type": "string" +} } }, -"path": "v1beta1/{+name}:complete", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1CompleteTrialRequest" -}, -"response": { -"$ref": "GoogleCloudAiplatformV1beta1Trial" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, +"schedules": { +"methods": { "create": { -"description": "Adds a user provided Trial to a Study.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", +"description": "Creates a Schedule.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules", "httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.trials.create", +"id": "aiplatform.projects.locations.schedules.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The resource name of the Study to create the Trial in. Format: `projects/{project}/locations/{location}/studies/{study}`", +"description": "Required. The resource name of the Location to create the Schedule in. Format: `projects/{project}/locations/{location}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/trials", +"path": "v1beta1/{+parent}/schedules", "request": { -"$ref": "GoogleCloudAiplatformV1beta1Trial" +"$ref": "GoogleCloudAiplatformV1beta1Schedule" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1Trial" +"$ref": "GoogleCloudAiplatformV1beta1Schedule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a Trial.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", +"description": "Deletes a Schedule.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.studies.trials.delete", +"id": "aiplatform.projects.locations.schedules.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", +"description": "Required. The name of the Schedule resource to be deleted. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets a Trial.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", +"description": "Gets a Schedule.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.studies.trials.get", +"id": "aiplatform.projects.locations.schedules.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the Trial resource. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", +"description": "Required. The name of the Schedule resource. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1Trial" +"$ref": "GoogleCloudAiplatformV1beta1Schedule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists the Trials associated with a Study.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", +"description": "Lists Schedules in a Location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules", "httpMethod": "GET", -"id": "aiplatform.projects.locations.studies.trials.list", +"id": "aiplatform.projects.locations.schedules.list", "parameterOrder": [ "parent" ], "parameters": { +"filter": { +"description": "Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state=\"ACTIVE\" AND display_name:\"my_schedule_*\"` * `NOT display_name=\"my_schedule\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `end_time>\"2021-05-18T00:00:00Z\" OR NOT end_time:*` * `create_pipeline_job_request:*`", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "A comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple order_by fields provided. For example, using \"create_time desc, end_time\" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time`", +"location": "query", +"type": "string" +}, "pageSize": { -"description": "Optional. The number of Trials to retrieve per \"page\" of results. If unspecified, the service will pick an appropriate default.", +"description": "The standard list page size. Default to 100 if not specified.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", +"description": "The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource name of the Study to list the Trial from. Format: `projects/{project}/locations/{location}/studies/{study}`", +"description": "Required. The resource name of the Location to list the Schedules from. Format: `projects/{project}/locations/{location}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/trials", +"path": "v1beta1/{+parent}/schedules", "response": { -"$ref": "GoogleCloudAiplatformV1beta1ListTrialsResponse" +"$ref": "GoogleCloudAiplatformV1beta1ListSchedulesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"listOptimalTrials": { -"description": "Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.trials.listOptimalTrials", +"patch": { +"description": "Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.schedules.patch", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The name of the Study that the optimal Trial belongs to.", +"name": { +"description": "Immutable. The resource name of the Schedule.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true, "type": "string" +}, +"updateMask": { +"description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, -"path": "v1beta1/{+parent}/trials:listOptimalTrials", +"path": "v1beta1/{+name}", "request": { -"$ref": "GoogleCloudAiplatformV1beta1ListOptimalTrialsRequest" +"$ref": "GoogleCloudAiplatformV1beta1Schedule" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1ListOptimalTrialsResponse" +"$ref": "GoogleCloudAiplatformV1beta1Schedule" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"stop": { -"description": "Stops a Trial.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop", +"pause": { +"description": "Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause", "httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.trials.stop", +"id": "aiplatform.projects.locations.schedules.pause", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", +"description": "Required. The name of the Schedule resource to be paused. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}:stop", +"path": "v1beta1/{+name}:pause", "request": { -"$ref": "GoogleCloudAiplatformV1beta1StopTrialRequest" +"$ref": "GoogleCloudAiplatformV1beta1PauseScheduleRequest" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1Trial" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"suggest": { -"description": "Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest", +"resume": { +"description": "Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume", "httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.trials.suggest", +"id": "aiplatform.projects.locations.schedules.resume", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The project and location that the Study belongs to. Format: `projects/{project}/locations/{location}/studies/{study}`", +"name": { +"description": "Required. The name of the Schedule resource to be resumed. Format: `projects/{project}/locations/{location}/schedules/{schedule}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/trials:suggest", +"path": "v1beta1/{+name}:resume", "request": { -"$ref": "GoogleCloudAiplatformV1beta1SuggestTrialsRequest" +"$ref": "GoogleCloudAiplatformV1beta1ResumeScheduleRequest" }, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -33265,9 +33885,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.trials.operations.cancel", +"id": "aiplatform.projects.locations.schedules.operations.cancel", "parameterOrder": [ "name" ], @@ -33275,7 +33895,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -33290,9 +33910,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.studies.trials.operations.delete", +"id": "aiplatform.projects.locations.schedules.operations.delete", "parameterOrder": [ "name" ], @@ -33300,7 +33920,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -33315,9 +33935,9 @@ }, "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.studies.trials.operations.get", +"id": "aiplatform.projects.locations.schedules.operations.get", "parameterOrder": [ "name" ], @@ -33325,7 +33945,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -33340,9 +33960,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.studies.trials.operations.list", +"id": "aiplatform.projects.locations.schedules.operations.list", "parameterOrder": [ "name" ], @@ -33355,7 +33975,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$", "required": true, "type": "string" }, @@ -33386,9 +34006,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.projects.locations.studies.trials.operations.wait", +"id": "aiplatform.projects.locations.schedules.operations.wait", "parameterOrder": [ "name" ], @@ -33396,7 +34016,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -33418,336 +34038,319 @@ } } } -} -} }, -"tensorboards": { +"semanticGovernancePolicies": { +"resources": { +"operations": { "methods": { -"batchRead": { -"description": "Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.batchRead", -"parameterOrder": [ -"tensorboard" -], -"parameters": { -"tensorboard": { -"description": "Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", -"required": true, -"type": "string" -}, -"timeSeries": { -"description": "Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", -"location": "query", -"repeated": true, -"type": "string" -} -}, -"path": "v1beta1/{+tensorboard}:batchRead", -"response": { -"$ref": "GoogleCloudAiplatformV1beta1BatchReadTensorboardTimeSeriesDataResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"create": { -"description": "Creates a Tensorboard.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards", +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.create", +"id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.cancel", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project}/locations/{location}`", +"name": { +"description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/tensorboards", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1Tensorboard" -}, +"path": "v1beta1/{+name}:cancel", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a Tensorboard.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.tensorboards.delete", +"id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the Tensorboard to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", +"description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets a Tensorboard.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", +"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": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.get", +"id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", +"description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1Tensorboard" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists Tensorboards in a Location.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards", +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.list", +"id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.list", "parameterOrder": [ -"parent" +"name" ], "parameters": { "filter": { -"description": "Lists the Tensorboards that match the filter expression.", +"description": "The standard list filter.", "location": "query", "type": "string" }, -"orderBy": { -"description": "Field to use to sort the list.", -"location": "query", +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$", +"required": true, "type": "string" }, "pageSize": { -"description": "The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.", +"description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token.", +"description": "The standard list page token.", "location": "query", "type": "string" }, -"parent": { -"description": "Required. The resource name of the Location to list Tensorboards. Format: `projects/{project}/locations/{location}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -}, -"readMask": { -"description": "Mask specifying which fields to read.", -"format": "google-fieldmask", +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", -"type": "string" +"type": "boolean" } }, -"path": "v1beta1/{+parent}/tensorboards", +"path": "v1beta1/{+name}/operations", "response": { -"$ref": "GoogleCloudAiplatformV1beta1ListTensorboardsResponse" +"$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, -"patch": { -"description": "Updates a Tensorboard.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", -"httpMethod": "PATCH", -"id": "aiplatform.projects.locations.tensorboards.patch", +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.wait", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", +"description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, -"updateMask": { -"description": "Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", -"format": "google-fieldmask", +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", "location": "query", "type": "string" } }, -"path": "v1beta1/{+name}", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1Tensorboard" -}, +"path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} +} +} }, -"readSize": { -"description": "Returns the storage size for a given TensorBoard instance.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.readSize", +"solvers": { +"resources": { +"operations": { +"methods": { +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.solvers.operations.delete", "parameterOrder": [ -"tensorboard" +"name" ], "parameters": { -"tensorboard": { -"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", +"name": { +"description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+tensorboard}:readSize", +"path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardSizeResponse" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"readUsage": { -"description": "Returns a list of monthly active users for a given TensorBoard instance.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage", +"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": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.readUsage", +"id": "aiplatform.projects.locations.solvers.operations.get", "parameterOrder": [ -"tensorboard" +"name" ], "parameters": { -"tensorboard": { -"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", +"name": { +"description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+tensorboard}:readUsage", +"path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardUsageResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} }, -"resources": { -"experiments": { -"methods": { -"batchCreate": { -"description": "Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.batchCreate", +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.solvers.operations.list", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.", +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+$", "required": true, "type": "string" -} }, -"path": "v1beta1/{+parent}:batchCreate", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesRequest" +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} }, +"path": "v1beta1/{+name}/operations", "response": { -"$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesResponse" +"$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} +} +} }, +"specialistPools": { +"methods": { "create": { -"description": "Creates a TensorboardExperiment.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", +"description": "Creates a SpecialistPool.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.create", +"id": "aiplatform.projects.locations.specialistPools.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", +"description": "Required. The parent Project name for the new SpecialistPool. The form is `projects/{project}/locations/{location}`.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" -}, -"tensorboardExperimentId": { -"description": "Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.", -"location": "query", -"type": "string" } }, -"path": "v1beta1/{+parent}/experiments", +"path": "v1beta1/{+parent}/specialistPools", "request": { -"$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" +"$ref": "GoogleCloudAiplatformV1beta1SpecialistPool" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a TensorboardExperiment.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", +"description": "Deletes a SpecialistPool as well as all Specialists in the pool.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.tensorboards.experiments.delete", +"id": "aiplatform.projects.locations.specialistPools.delete", "parameterOrder": [ "name" ], "parameters": { +"force": { +"description": "If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.)", +"location": "query", +"type": "boolean" +}, "name": { -"description": "Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", +"description": "Required. The resource name of the SpecialistPool to delete. Format: `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", "required": true, "type": "string" } @@ -33761,102 +34364,90 @@ ] }, "get": { -"description": "Gets a TensorboardExperiment.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", +"description": "Gets a SpecialistPool.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.get", +"id": "aiplatform.projects.locations.specialistPools.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the TensorboardExperiment resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", +"description": "Required. The name of the SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" +"$ref": "GoogleCloudAiplatformV1beta1SpecialistPool" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists TensorboardExperiments in a Location.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", +"description": "Lists SpecialistPools in a Location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.list", +"id": "aiplatform.projects.locations.specialistPools.list", "parameterOrder": [ "parent" ], "parameters": { -"filter": { -"description": "Lists the TensorboardExperiments that match the filter expression.", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Field to use to sort the list.", -"location": "query", -"type": "string" -}, "pageSize": { -"description": "The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", +"description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token.", +"description": "The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", +"description": "Required. The name of the SpecialistPool's parent resource. Format: `projects/{project}/locations/{location}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "readMask": { -"description": "Mask specifying which fields to read.", +"description": "Mask specifying which fields to read. FieldMask represents a set of", "format": "google-fieldmask", "location": "query", "type": "string" } }, -"path": "v1beta1/{+parent}/experiments", +"path": "v1beta1/{+parent}/specialistPools", "response": { -"$ref": "GoogleCloudAiplatformV1beta1ListTensorboardExperimentsResponse" +"$ref": "GoogleCloudAiplatformV1beta1ListSpecialistPoolsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { -"description": "Updates a TensorboardExperiment.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", +"description": "Updates a SpecialistPool.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}", "httpMethod": "PATCH", -"id": "aiplatform.projects.locations.tensorboards.experiments.patch", +"id": "aiplatform.projects.locations.specialistPools.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", +"description": "Required. The resource name of the SpecialistPool.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", +"description": "Required. The update mask applies to the resource.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -33864,38 +34455,10 @@ }, "path": "v1beta1/{+name}", "request": { -"$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" -}, -"response": { -"$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"write": { -"description": "Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.write", -"parameterOrder": [ -"tensorboardExperiment" -], -"parameters": { -"tensorboardExperiment": { -"description": "Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+tensorboardExperiment}:write", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataRequest" +"$ref": "GoogleCloudAiplatformV1beta1SpecialistPool" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -33907,9 +34470,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.operations.cancel", +"id": "aiplatform.projects.locations.specialistPools.operations.cancel", "parameterOrder": [ "name" ], @@ -33917,7 +34480,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -33932,9 +34495,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.tensorboards.experiments.operations.delete", +"id": "aiplatform.projects.locations.specialistPools.operations.delete", "parameterOrder": [ "name" ], @@ -33942,7 +34505,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -33957,9 +34520,9 @@ }, "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.operations.get", +"id": "aiplatform.projects.locations.specialistPools.operations.get", "parameterOrder": [ "name" ], @@ -33967,7 +34530,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -33982,9 +34545,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.operations.list", +"id": "aiplatform.projects.locations.specialistPools.operations.list", "parameterOrder": [ "name" ], @@ -33997,7 +34560,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$", "required": true, "type": "string" }, @@ -34028,9 +34591,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.operations.wait", +"id": "aiplatform.projects.locations.specialistPools.operations.wait", "parameterOrder": [ "name" ], @@ -34038,7 +34601,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -34058,231 +34621,148 @@ ] } } -}, -"runs": { -"methods": { -"batchCreate": { -"description": "Batch create TensorboardRuns.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The parent field in the CreateTensorboardRunRequest messages must match this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", -"required": true, -"type": "string" +} } }, -"path": "v1beta1/{+parent}/runs:batchCreate", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsRequest" -}, -"response": { -"$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, +"studies": { +"methods": { "create": { -"description": "Creates a TensorboardRun.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs", +"description": "Creates a Study. A resource name will be generated after creation of the Study.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.create", +"id": "aiplatform.projects.locations.studies.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", +"description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" -}, -"tensorboardRunId": { -"description": "Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.", -"location": "query", -"type": "string" } }, -"path": "v1beta1/{+parent}/runs", +"path": "v1beta1/{+parent}/studies", "request": { -"$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" +"$ref": "GoogleCloudAiplatformV1beta1Study" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" +"$ref": "GoogleCloudAiplatformV1beta1Study" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a TensorboardRun.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", +"description": "Deletes a Study.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.delete", +"id": "aiplatform.projects.locations.studies.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the TensorboardRun to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", +"description": "Required. The name of the Study resource to be deleted. Format: `projects/{project}/locations/{location}/studies/{study}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets a TensorboardRun.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", +"description": "Gets a Study by name.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.get", +"id": "aiplatform.projects.locations.studies.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the TensorboardRun resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", +"description": "Required. The name of the Study resource. Format: `projects/{project}/locations/{location}/studies/{study}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" +"$ref": "GoogleCloudAiplatformV1beta1Study" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists TensorboardRuns in a Location.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs", +"description": "Lists all the studies in a region for an associated project.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.list", +"id": "aiplatform.projects.locations.studies.list", "parameterOrder": [ "parent" ], "parameters": { -"filter": { -"description": "Lists the TensorboardRuns that match the filter expression.", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Field to use to sort the list.", -"location": "query", -"type": "string" -}, "pageSize": { -"description": "The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", +"description": "Optional. The maximum number of studies to return per \"page\" of results. If unspecified, service will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token.", +"description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", -"required": true, -"type": "string" -}, -"readMask": { -"description": "Mask specifying which fields to read.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -} -}, -"path": "v1beta1/{+parent}/runs", -"response": { -"$ref": "GoogleCloudAiplatformV1beta1ListTensorboardRunsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" -] -}, -"patch": { -"description": "Updates a TensorboardRun.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", -"httpMethod": "PATCH", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", +"description": "Required. The resource name of the Location to list the Study from. Format: `projects/{project}/locations/{location}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" -}, -"updateMask": { -"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, -"path": "v1beta1/{+name}", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" -}, +"path": "v1beta1/{+parent}/studies", "response": { -"$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" +"$ref": "GoogleCloudAiplatformV1beta1ListStudiesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"write": { -"description": "Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write", +"lookup": { +"description": "Looks a study up using the user-defined display_name field instead of the fully qualified resource name.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies:lookup", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.write", +"id": "aiplatform.projects.locations.studies.lookup", "parameterOrder": [ -"tensorboardRun" +"parent" ], "parameters": { -"tensorboardRun": { -"description": "Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", +"parent": { +"description": "Required. The resource name of the Location to get the Study from. Format: `projects/{project}/locations/{location}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+tensorboardRun}:write", +"path": "v1beta1/{+parent}/studies:lookup", "request": { -"$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardRunDataRequest" +"$ref": "GoogleCloudAiplatformV1beta1LookupStudyRequest" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardRunDataResponse" +"$ref": "GoogleCloudAiplatformV1beta1Study" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -34294,9 +34774,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel", +"id": "aiplatform.projects.locations.studies.operations.cancel", "parameterOrder": [ "name" ], @@ -34304,7 +34784,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -34319,9 +34799,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete", +"id": "aiplatform.projects.locations.studies.operations.delete", "parameterOrder": [ "name" ], @@ -34329,7 +34809,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -34344,9 +34824,9 @@ }, "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.get", +"id": "aiplatform.projects.locations.studies.operations.get", "parameterOrder": [ "name" ], @@ -34354,7 +34834,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -34369,9 +34849,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.list", +"id": "aiplatform.projects.locations.studies.operations.list", "parameterOrder": [ "name" ], @@ -34384,7 +34864,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" }, @@ -34415,9 +34895,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait", +"id": "aiplatform.projects.locations.studies.operations.wait", "parameterOrder": [ "name" ], @@ -34425,7 +34905,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -34446,274 +34926,288 @@ } } }, -"timeSeries": { +"trials": { "methods": { -"create": { -"description": "Creates a TensorboardTimeSeries.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries", +"addTrialMeasurement": { +"description": "Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create", +"id": "aiplatform.projects.locations.studies.trials.addTrialMeasurement", "parameterOrder": [ -"parent" +"trialName" ], "parameters": { -"parent": { -"description": "Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", +"trialName": { +"description": "Required. The name of the trial to add measurement. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true, "type": "string" +} }, -"tensorboardTimeSeriesId": { -"description": "Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match \"a-z0-9{0, 127}\"", -"location": "query", +"path": "v1beta1/{+trialName}:addTrialMeasurement", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1AddTrialMeasurementRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1Trial" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"checkTrialEarlyStoppingState": { +"description": "Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState", +"parameterOrder": [ +"trialName" +], +"parameters": { +"trialName": { +"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", +"required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/timeSeries", +"path": "v1beta1/{+trialName}:checkTrialEarlyStoppingState", "request": { -"$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" +"$ref": "GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateRequest" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"delete": { -"description": "Deletes a TensorboardTimeSeries.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", -"httpMethod": "DELETE", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete", +"complete": { +"description": "Marks a Trial as complete.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.studies.trials.complete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", +"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}", +"path": "v1beta1/{+name}:complete", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1CompleteTrialRequest" +}, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1beta1Trial" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"exportTensorboardTimeSeries": { -"description": "Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries", +"create": { +"description": "Adds a user provided Trial to a Study.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries", +"id": "aiplatform.projects.locations.studies.trials.create", "parameterOrder": [ -"tensorboardTimeSeries" +"parent" ], "parameters": { -"tensorboardTimeSeries": { -"description": "Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", +"parent": { +"description": "Required. The resource name of the Study to create the Trial in. Format: `projects/{project}/locations/{location}/studies/{study}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries", +"path": "v1beta1/{+parent}/trials", "request": { -"$ref": "GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataRequest" +"$ref": "GoogleCloudAiplatformV1beta1Trial" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataResponse" +"$ref": "GoogleCloudAiplatformV1beta1Trial" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a Trial.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.studies.trials.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets a TensorboardTimeSeries.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", +"description": "Gets a Trial.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get", +"id": "aiplatform.projects.locations.studies.trials.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", +"description": "Required. The name of the Trial resource. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" +"$ref": "GoogleCloudAiplatformV1beta1Trial" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists TensorboardTimeSeries in a Location.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries", +"description": "Lists the Trials associated with a Study.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list", +"id": "aiplatform.projects.locations.studies.trials.list", "parameterOrder": [ "parent" ], "parameters": { -"filter": { -"description": "Lists the TensorboardTimeSeries that match the filter expression.", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Field to use to sort the list.", -"location": "query", -"type": "string" -}, "pageSize": { -"description": "The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", +"description": "Optional. The number of Trials to retrieve per \"page\" of results. If unspecified, the service will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token.", +"description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", +"description": "Required. The resource name of the Study to list the Trial from. Format: `projects/{project}/locations/{location}/studies/{study}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" -}, -"readMask": { -"description": "Mask specifying which fields to read.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, -"path": "v1beta1/{+parent}/timeSeries", +"path": "v1beta1/{+parent}/trials", "response": { -"$ref": "GoogleCloudAiplatformV1beta1ListTensorboardTimeSeriesResponse" +"$ref": "GoogleCloudAiplatformV1beta1ListTrialsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, -"patch": { -"description": "Updates a TensorboardTimeSeries.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", -"httpMethod": "PATCH", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch", +"listOptimalTrials": { +"description": "Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.studies.trials.listOptimalTrials", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "Output only. Name of the TensorboardTimeSeries.", +"parent": { +"description": "Required. The name of the Study that the optimal Trial belongs to.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" -}, -"updateMask": { -"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, -"path": "v1beta1/{+name}", +"path": "v1beta1/{+parent}/trials:listOptimalTrials", "request": { -"$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" +"$ref": "GoogleCloudAiplatformV1beta1ListOptimalTrialsRequest" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" +"$ref": "GoogleCloudAiplatformV1beta1ListOptimalTrialsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"read": { -"description": "Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read", +"stop": { +"description": "Stops a Trial.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.studies.trials.stop", "parameterOrder": [ -"tensorboardTimeSeries" +"name" ], "parameters": { -"filter": { -"description": "Reads the TensorboardTimeSeries' data that match the filter expression.", -"location": "query", -"type": "string" -}, -"maxDataPoints": { -"description": "The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"tensorboardTimeSeries": { -"description": "Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", +"name": { +"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+tensorboardTimeSeries}:read", +"path": "v1beta1/{+name}:stop", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1StopTrialRequest" +}, "response": { -"$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardTimeSeriesDataResponse" +"$ref": "GoogleCloudAiplatformV1beta1Trial" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, -"readBlobData": { -"description": "Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData", +"suggest": { +"description": "Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.studies.trials.suggest", "parameterOrder": [ -"timeSeries" +"parent" ], "parameters": { -"blobIds": { -"description": "IDs of the blobs to read.", -"location": "query", -"repeated": true, -"type": "string" -}, -"timeSeries": { -"description": "Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", +"parent": { +"description": "Required. The project and location that the Study belongs to. Format: `projects/{project}/locations/{location}/studies/{study}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+timeSeries}:readBlobData", +"path": "v1beta1/{+parent}/trials:suggest", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1SuggestTrialsRequest" +}, "response": { -"$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardBlobDataResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } }, @@ -34722,9 +35216,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel", +"id": "aiplatform.projects.locations.studies.trials.operations.cancel", "parameterOrder": [ "name" ], @@ -34732,7 +35226,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -34747,9 +35241,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete", +"id": "aiplatform.projects.locations.studies.trials.operations.delete", "parameterOrder": [ "name" ], @@ -34757,7 +35251,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -34772,9 +35266,9 @@ }, "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get", +"id": "aiplatform.projects.locations.studies.trials.operations.get", "parameterOrder": [ "name" ], @@ -34782,7 +35276,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -34797,9 +35291,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list", +"id": "aiplatform.projects.locations.studies.trials.operations.list", "parameterOrder": [ "name" ], @@ -34812,7 +35306,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$", "required": true, "type": "string" }, @@ -34843,9 +35337,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait", +"id": "aiplatform.projects.locations.studies.trials.operations.wait", "parameterOrder": [ "name" ], @@ -34853,7 +35347,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -34877,238 +35371,334 @@ } } } -} -} }, -"operations": { +"tensorboards": { "methods": { -"cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel", +"batchRead": { +"description": "Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tensorboards.batchRead", +"parameterOrder": [ +"tensorboard" +], +"parameters": { +"tensorboard": { +"description": "Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", +"required": true, +"type": "string" +}, +"timeSeries": { +"description": "Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", +"location": "query", +"repeated": true, +"type": "string" +} +}, +"path": "v1beta1/{+tensorboard}:batchRead", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1BatchReadTensorboardTimeSeriesDataResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"create": { +"description": "Creates a Tensorboard.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.operations.cancel", +"id": "aiplatform.projects.locations.tensorboards.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", +"parent": { +"description": "Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project}/locations/{location}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}:cancel", +"path": "v1beta1/{+parent}/tensorboards", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1Tensorboard" +}, "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", +"description": "Deletes a Tensorboard.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.tensorboards.operations.delete", +"id": "aiplatform.projects.locations.tensorboards.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to be deleted.", +"description": "Required. The name of the Tensorboard to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", +"description": "Gets a Tensorboard.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.operations.get", +"id": "aiplatform.projects.locations.tensorboards.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1beta1Tensorboard" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" ] }, "list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations", +"description": "Lists Tensorboards in a Location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tensorboards.operations.list", +"id": "aiplatform.projects.locations.tensorboards.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { "filter": { -"description": "The standard list filter.", +"description": "Lists the Tensorboards that match the filter expression.", "location": "query", "type": "string" }, -"name": { -"description": "The name of the operation's parent resource.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", -"required": true, +"orderBy": { +"description": "Field to use to sort the list.", +"location": "query", "type": "string" }, "pageSize": { -"description": "The standard list page size.", +"description": "The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token.", +"description": "A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token.", "location": "query", "type": "string" }, -"returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"parent": { +"description": "Required. The resource name of the Location to list Tensorboards. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"readMask": { +"description": "Mask specifying which fields to read.", +"format": "google-fieldmask", "location": "query", -"type": "boolean" +"type": "string" } }, -"path": "v1beta1/{+name}/operations", +"path": "v1beta1/{+parent}/tensorboards", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudAiplatformV1beta1ListTensorboardsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" ] }, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.tensorboards.operations.wait", +"patch": { +"description": "Updates a Tensorboard.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.tensorboards.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to wait on.", +"description": "Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" }, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", +"format": "google-fieldmask", "location": "query", "type": "string" } }, -"path": "v1beta1/{+name}:wait", +"path": "v1beta1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1Tensorboard" +}, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} }, -"trainingPipelines": { -"methods": { -"cancel": { -"description": "Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.trainingPipelines.cancel", +"readSize": { +"description": "Returns the storage size for a given TensorBoard instance.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tensorboards.readSize", "parameterOrder": [ -"name" +"tensorboard" ], "parameters": { -"name": { -"description": "Required. The name of the TrainingPipeline to cancel. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", +"tensorboard": { +"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}:cancel", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest" -}, +"path": "v1beta1/{+tensorboard}:readSize", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardSizeResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"create": { -"description": "Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.trainingPipelines.create", +"readUsage": { +"description": "Returns a list of monthly active users for a given TensorBoard instance.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tensorboards.readUsage", "parameterOrder": [ -"parent" +"tensorboard" ], "parameters": { -"parent": { -"description": "Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}`", +"tensorboard": { +"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/trainingPipelines", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline" -}, +"path": "v1beta1/{+tensorboard}:readUsage", "response": { -"$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline" +"$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardUsageResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} }, -"delete": { -"description": "Deletes a TrainingPipeline.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", -"httpMethod": "DELETE", -"id": "aiplatform.projects.locations.trainingPipelines.delete", +"resources": { +"experiments": { +"methods": { +"batchCreate": { +"description": "Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tensorboards.experiments.batchCreate", "parameterOrder": [ -"name" +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}:batchCreate", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"create": { +"description": "Creates a TensorboardExperiment.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tensorboards.experiments.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", +"required": true, +"type": "string" +}, +"tensorboardExperimentId": { +"description": "Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+parent}/experiments", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a TensorboardExperiment.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.tensorboards.experiments.delete", +"parameterOrder": [ +"name" ], "parameters": { "name": { -"description": "Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", +"description": "Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" } @@ -35122,59 +35712,65 @@ ] }, "get": { -"description": "Gets a TrainingPipeline.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", +"description": "Gets a TensorboardExperiment.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.trainingPipelines.get", +"id": "aiplatform.projects.locations.tensorboards.experiments.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", +"description": "Required. The name of the TensorboardExperiment resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline" +"$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" ] }, "list": { -"description": "Lists TrainingPipelines in a Location.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", +"description": "Lists TensorboardExperiments in a Location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments", "httpMethod": "GET", -"id": "aiplatform.projects.locations.trainingPipelines.list", +"id": "aiplatform.projects.locations.tensorboards.experiments.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { -"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"PIPELINE_STATE_SUCCEEDED\" AND display_name:\"my_pipeline_*\"` * `state!=\"PIPELINE_STATE_FAILED\" OR display_name=\"my_pipeline\"` * `NOT display_name=\"my_pipeline\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `training_task_definition:\"*automl_text_classification*\"`", +"description": "Lists the TensorboardExperiments that match the filter expression.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field to use to sort the list.", "location": "query", "type": "string" }, "pageSize": { -"description": "The standard list page size.", +"description": "The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.", +"description": "A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}`", +"description": "Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", "required": true, "type": "string" }, @@ -35185,9 +35781,72 @@ "type": "string" } }, -"path": "v1beta1/{+parent}/trainingPipelines", +"path": "v1beta1/{+parent}/experiments", "response": { -"$ref": "GoogleCloudAiplatformV1beta1ListTrainingPipelinesResponse" +"$ref": "GoogleCloudAiplatformV1beta1ListTensorboardExperimentsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"patch": { +"description": "Updates a TensorboardExperiment.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.tensorboards.experiments.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"write": { +"description": "Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tensorboards.experiments.write", +"parameterOrder": [ +"tensorboardExperiment" +], +"parameters": { +"tensorboardExperiment": { +"description": "Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+tensorboardExperiment}:write", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -35199,9 +35858,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.trainingPipelines.operations.cancel", +"id": "aiplatform.projects.locations.tensorboards.experiments.operations.cancel", "parameterOrder": [ "name" ], @@ -35209,7 +35868,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -35224,9 +35883,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.trainingPipelines.operations.delete", +"id": "aiplatform.projects.locations.tensorboards.experiments.operations.delete", "parameterOrder": [ "name" ], @@ -35234,7 +35893,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -35249,9 +35908,9 @@ }, "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.trainingPipelines.operations.get", +"id": "aiplatform.projects.locations.tensorboards.experiments.operations.get", "parameterOrder": [ "name" ], @@ -35259,7 +35918,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -35274,9 +35933,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.trainingPipelines.operations.list", +"id": "aiplatform.projects.locations.tensorboards.experiments.operations.list", "parameterOrder": [ "name" ], @@ -35289,7 +35948,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" }, @@ -35320,9 +35979,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.projects.locations.trainingPipelines.operations.wait", +"id": "aiplatform.projects.locations.tensorboards.experiments.operations.wait", "parameterOrder": [ "name" ], @@ -35330,7 +35989,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -35350,184 +36009,231 @@ ] } } -} -} }, -"tuningJobs": { +"runs": { "methods": { -"cancel": { -"description": "Cancels a tuning job. Starts an asynchronous cancellation request. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the tuning job is not deleted. Instead, its state is set to `CANCELLED`, and `error` is set to a status with a `google.rpc.Status.code` of 1, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel", +"batchCreate": { +"description": "Batch create TensorboardRuns.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tuningJobs.cancel", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "Required. The name of the tuning job to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", +"parent": { +"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The parent field in the CreateTensorboardRunRequest messages must match this field.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}:cancel", +"path": "v1beta1/{+parent}/runs:batchCreate", "request": { -"$ref": "GoogleCloudAiplatformV1beta1CancelTuningJobRequest" +"$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsRequest" }, "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { -"description": "Creates a tuning job. A created tuning job will be subsequently executed to start the model tuning process.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs", +"description": "Creates a TensorboardRun.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tuningJobs.create", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The resource name of the location to create the tuning job in. Format: `projects/{project}/locations/{location}`", +"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" +}, +"tensorboardRunId": { +"description": "Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.", +"location": "query", +"type": "string" } }, -"path": "v1beta1/{+parent}/tuningJobs", +"path": "v1beta1/{+parent}/runs", "request": { -"$ref": "GoogleCloudAiplatformV1beta1TuningJob" +"$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1TuningJob" +"$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a TensorboardRun.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the TensorboardRun to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets a tuning job.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}", +"description": "Gets a TensorboardRun.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tuningJobs.get", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the tuning job to retrieve. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", +"description": "Required. The name of the TensorboardRun resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1TuningJob" +"$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" ] }, "list": { -"description": "Lists tuning jobs in a location.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs", +"description": "Lists TensorboardRuns in a Location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs", "httpMethod": "GET", -"id": "aiplatform.projects.locations.tuningJobs.list", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { -"description": "Optional. The standard list filter.", +"description": "Lists the TensorboardRuns that match the filter expression.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field to use to sort the list.", "location": "query", "type": "string" }, "pageSize": { -"description": "Optional. The standard list page size.", +"description": "The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. The standard list page token. Typically obtained from ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJobs call.", +"description": "A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource name of the location to list the tuning jobs from. Format: `projects/{project}/locations/{location}`", +"description": "Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$", "required": true, "type": "string" +}, +"readMask": { +"description": "Mask specifying which fields to read.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, -"path": "v1beta1/{+parent}/tuningJobs", +"path": "v1beta1/{+parent}/runs", "response": { -"$ref": "GoogleCloudAiplatformV1beta1ListTuningJobsResponse" +"$ref": "GoogleCloudAiplatformV1beta1ListTensorboardRunsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" ] }, -"optimizePrompt": { -"description": "Optimizes a prompt. Given a prompt, this method returns a stream of optimized prompts expanded from the original prompt.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:optimizePrompt", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.tuningJobs.optimizePrompt", +"patch": { +"description": "Updates a TensorboardRun.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.patch", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The resource name of the location to optimize the prompt in. Format: `projects/{project}/locations/{location}`", +"name": { +"description": "Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, -"path": "v1beta1/{+parent}/tuningJobs:optimizePrompt", +"path": "v1beta1/{+name}", "request": { -"$ref": "GoogleCloudAiplatformV1beta1OptimizePromptRequest" +"$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1OptimizePromptResponse" +"$ref": "GoogleCloudAiplatformV1beta1TensorboardRun" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"rebaseTunedModel": { -"description": "Rebase a tuned model. A rebase operation takes a model that was previously tuned on a base model version, and retunes it on a new base model version. The rebase operation creates a new tuning job and a new tuned model.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel", +"write": { +"description": "Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write", "httpMethod": "POST", -"id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.write", "parameterOrder": [ -"parent" +"tensorboardRun" ], "parameters": { -"parent": { -"description": "Required. The resource name of the location in which to rebase the Model. Format: `projects/{project}/locations/{location}`", +"tensorboardRun": { +"description": "Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/tuningJobs:rebaseTunedModel", +"path": "v1beta1/{+tensorboardRun}:write", "request": { -"$ref": "GoogleCloudAiplatformV1beta1RebaseTunedModelRequest" +"$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardRunDataRequest" }, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardRunDataResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -35537,350 +36243,3748 @@ "resources": { "operations": { "methods": { -"delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", -"httpMethod": "DELETE", -"id": "aiplatform.projects.locations.tuningJobs.operations.delete", +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to be deleted.", +"description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}", +"path": "v1beta1/{+name}:cancel", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} -} -} }, -"modelGardenEula": { -"methods": { -"accept": { -"description": "Accepts the EULA acceptance status of a publisher model.", -"flatPath": "v1beta1/projects/{projectsId}/modelGardenEula:accept", -"httpMethod": "POST", -"id": "aiplatform.projects.modelGardenEula.accept", +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The project requesting access for named model. The format is `projects/{project}`.", +"name": { +"description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/modelGardenEula:accept", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1AcceptPublisherModelEulaRequest" -}, +"path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"check": { -"description": "Checks the EULA acceptance status of a publisher model.", -"flatPath": "v1beta1/projects/{projectsId}/modelGardenEula:check", -"httpMethod": "POST", -"id": "aiplatform.projects.modelGardenEula.check", +"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": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.get", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The project requesting access for named model. The format is `projects/{project}`.", +"name": { +"description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/modelGardenEula:check", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1CheckPublisherModelEulaAcceptanceRequest" -}, +"path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} }, -"publishers": { -"resources": { -"models": { -"methods": { -"enableModel": { -"description": "Enables model for the project if prerequisites are met (e.g. completed questionnaire and consents, or an active Private Offer).", -"flatPath": "v1beta1/projects/{projectsId}/publishers/{publishersId}/models/{modelsId}:enableModel", -"httpMethod": "POST", -"id": "aiplatform.projects.publishers.models.enableModel", +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.list", "parameterOrder": [ -"parent", "name" ], "parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, "name": { -"description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`", +"description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^publishers/[^/]+/models/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", "required": true, "type": "string" }, -"parent": { -"description": "Required. The project requesting access for named model. Format: `projects/{project}`", -"location": "path", -"pattern": "^projects/[^/]+$", -"required": true, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", "type": "string" -} }, -"path": "v1beta1/{+parent}/{+name}:enableModel", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1EnableModelRequest" +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} }, +"path": "v1beta1/{+name}/operations", "response": { -"$ref": "GoogleCloudAiplatformV1beta1EnableModelResponse" +"$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} -} -} }, -"publishers": { -"resources": { -"models": { -"methods": { -"computeTokens": { -"description": "Return a list of tokens based on the input text.", -"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:computeTokens", -"httpMethod": "POST", -"id": "aiplatform.publishers.models.computeTokens", +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"timeSeries": { +"methods": { +"create": { +"description": "Creates a TensorboardTimeSeries.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", +"required": true, +"type": "string" +}, +"tensorboardTimeSeriesId": { +"description": "Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match \"a-z0-9{0, 127}\"", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+parent}/timeSeries", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a TensorboardTimeSeries.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"exportTensorboardTimeSeries": { +"description": "Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries", +"parameterOrder": [ +"tensorboardTimeSeries" +], +"parameters": { +"tensorboardTimeSeries": { +"description": "Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a TensorboardTimeSeries.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"list": { +"description": "Lists TensorboardTimeSeries in a Location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Lists the TensorboardTimeSeries that match the filter expression.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Field to use to sort the list.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$", +"required": true, +"type": "string" +}, +"readMask": { +"description": "Mask specifying which fields to read.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+parent}/timeSeries", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ListTensorboardTimeSeriesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"patch": { +"description": "Updates a TensorboardTimeSeries.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Output only. Name of the TensorboardTimeSeries.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"read": { +"description": "Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read", +"parameterOrder": [ +"tensorboardTimeSeries" +], +"parameters": { +"filter": { +"description": "Reads the TensorboardTimeSeries' data that match the filter expression.", +"location": "query", +"type": "string" +}, +"maxDataPoints": { +"description": "The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"tensorboardTimeSeries": { +"description": "Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+tensorboardTimeSeries}:read", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardTimeSeriesDataResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"readBlobData": { +"description": "Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData", +"parameterOrder": [ +"timeSeries" +], +"parameters": { +"blobIds": { +"description": "IDs of the blobs to read.", +"location": "query", +"repeated": true, +"type": "string" +}, +"timeSeries": { +"description": "Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+timeSeries}:readBlobData", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardBlobDataResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +} +}, +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +}, +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tensorboards.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.tensorboards.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tensorboards.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tensorboards.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tensorboards.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"trainingPipelines": { +"methods": { +"cancel": { +"description": "Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.trainingPipelines.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the TrainingPipeline to cancel. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest" +}, +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"create": { +"description": "Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.trainingPipelines.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/trainingPipelines", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a TrainingPipeline.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.trainingPipelines.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a TrainingPipeline.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.trainingPipelines.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists TrainingPipelines in a Location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.trainingPipelines.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"PIPELINE_STATE_SUCCEEDED\" AND display_name:\"my_pipeline_*\"` * `state!=\"PIPELINE_STATE_FAILED\" OR display_name=\"my_pipeline\"` * `NOT display_name=\"my_pipeline\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `training_task_definition:\"*automl_text_classification*\"`", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"readMask": { +"description": "Mask specifying which fields to read.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+parent}/trainingPipelines", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ListTrainingPipelinesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.trainingPipelines.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.trainingPipelines.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.trainingPipelines.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.trainingPipelines.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.trainingPipelines.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"tuningJobs": { +"methods": { +"cancel": { +"description": "Cancels a tuning job. Starts an asynchronous cancellation request. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the tuning job is not deleted. Instead, its state is set to `CANCELLED`, and `error` is set to a status with a `google.rpc.Status.code` of 1, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tuningJobs.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the tuning job to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1CancelTuningJobRequest" +}, +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"create": { +"description": "Creates a tuning job. A created tuning job will be subsequently executed to start the model tuning process.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tuningJobs.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the location to create the tuning job in. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/tuningJobs", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1TuningJob" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1TuningJob" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a tuning job.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tuningJobs.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the tuning job to retrieve. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1TuningJob" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists tuning jobs in a location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tuningJobs.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The standard list filter.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The standard list page token. Typically obtained from ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJobs call.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the location to list the tuning jobs from. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/tuningJobs", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ListTuningJobsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"optimizePrompt": { +"description": "Optimizes a prompt. Given a prompt, this method returns a stream of optimized prompts expanded from the original prompt.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:optimizePrompt", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tuningJobs.optimizePrompt", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the location to optimize the prompt in. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/tuningJobs:optimizePrompt", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1OptimizePromptRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1OptimizePromptResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"rebaseTunedModel": { +"description": "Rebase a tuned model. A rebase operation takes a model that was previously tuned on a base model version, and retunes it on a new base model version. The rebase operation creates a new tuning job and a new tuned model.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the location in which to rebase the Model. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/tuningJobs:rebaseTunedModel", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1RebaseTunedModelRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"operations": { +"methods": { +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.tuningJobs.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +}, +"modelGardenEula": { +"methods": { +"accept": { +"description": "Accepts the EULA acceptance status of a publisher model.", +"flatPath": "v1beta1/projects/{projectsId}/modelGardenEula:accept", +"httpMethod": "POST", +"id": "aiplatform.projects.modelGardenEula.accept", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The project requesting access for named model. The format is `projects/{project}`.", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/modelGardenEula:accept", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1AcceptPublisherModelEulaRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"check": { +"description": "Checks the EULA acceptance status of a publisher model.", +"flatPath": "v1beta1/projects/{projectsId}/modelGardenEula:check", +"httpMethod": "POST", +"id": "aiplatform.projects.modelGardenEula.check", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The project requesting access for named model. The format is `projects/{project}`.", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/modelGardenEula:check", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1CheckPublisherModelEulaAcceptanceRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"publishers": { +"resources": { +"models": { +"methods": { +"enableModel": { +"description": "Enables model for the project if prerequisites are met (e.g. completed questionnaire and consents, or an active Private Offer).", +"flatPath": "v1beta1/projects/{projectsId}/publishers/{publishersId}/models/{modelsId}:enableModel", +"httpMethod": "POST", +"id": "aiplatform.projects.publishers.models.enableModel", +"parameterOrder": [ +"parent", +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`", +"location": "path", +"pattern": "^publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +}, +"parent": { +"description": "Required. The project requesting access for named model. Format: `projects/{project}`", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/{+name}:enableModel", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1EnableModelRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1EnableModelResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +}, +"publishers": { +"resources": { +"models": { +"methods": { +"computeTokens": { +"description": "Return a list of tokens based on the input text.", +"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:computeTokens", +"httpMethod": "POST", +"id": "aiplatform.publishers.models.computeTokens", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"endpoint": { +"description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", +"location": "path", +"pattern": "^publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+endpoint}:computeTokens", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"countTokens": { +"description": "Perform a token counting.", +"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:countTokens", +"httpMethod": "POST", +"id": "aiplatform.publishers.models.countTokens", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"endpoint": { +"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"location": "path", +"pattern": "^publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+endpoint}:countTokens", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"fetchPredictOperation": { +"description": "Fetch an asynchronous online prediction operation.", +"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation", +"httpMethod": "POST", +"id": "aiplatform.publishers.models.fetchPredictOperation", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", +"location": "path", +"pattern": "^publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+endpoint}:fetchPredictOperation", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"generateContent": { +"description": "Generate content with multimodal inputs.", +"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:generateContent", +"httpMethod": "POST", +"id": "aiplatform.publishers.models.generateContent", +"parameterOrder": [ +"model" +], +"parameters": { +"model": { +"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"location": "path", +"pattern": "^publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+model}:generateContent", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"get": { +"description": "Gets a Model Garden publisher model.", +"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}", +"httpMethod": "GET", +"id": "aiplatform.publishers.models.get", +"parameterOrder": [ +"name" +], +"parameters": { +"huggingFaceToken": { +"description": "Optional. Token used to access Hugging Face gated models.", +"location": "query", +"type": "string" +}, +"includeEquivalentModelGardenModelDeploymentConfigs": { +"description": "Optional. Whether to cnclude the deployment configs from the equivalent Model Garden model if the requested model is a Hugging Face model.", +"location": "query", +"type": "boolean" +}, +"isHuggingFaceModel": { +"description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.", +"location": "query", +"type": "boolean" +}, +"languageCode": { +"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`", +"location": "path", +"pattern": "^publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "Optional. PublisherModel view specifying which fields to read.", +"enum": [ +"PUBLISHER_MODEL_VIEW_UNSPECIFIED", +"PUBLISHER_MODEL_VIEW_BASIC", +"PUBLISHER_MODEL_VIEW_FULL", +"PUBLISHER_MODEL_VERSION_VIEW_BASIC" +], +"enumDescriptions": [ +"The default / unset value. The API will default to the BASIC view.", +"Include basic metadata about the publisher model, but not the full contents.", +"Include everything.", +"Include: VersionId, ModelVersionExternalName, and SupportedActions." +], +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1PublisherModel" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists publisher models in Model Garden.", +"flatPath": "v1beta1/publishers/{publishersId}/models", +"httpMethod": "GET", +"id": "aiplatform.publishers.models.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The standard list filter.", +"location": "query", +"type": "string" +}, +"languageCode": { +"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in. If not set, by default English (en).", +"location": "query", +"type": "string" +}, +"listAllVersions": { +"description": "Optional. List all publisher model versions if the flag is set to true.", +"location": "query", +"type": "boolean" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The standard list page token. Typically obtained via ListPublisherModelsResponse.next_page_token of the previous ModelGardenService.ListPublisherModels call.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The name of the Publisher from which to list the PublisherModels. Format: `publishers/{publisher}`", +"location": "path", +"pattern": "^publishers/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "Optional. PublisherModel view specifying which fields to read.", +"enum": [ +"PUBLISHER_MODEL_VIEW_UNSPECIFIED", +"PUBLISHER_MODEL_VIEW_BASIC", +"PUBLISHER_MODEL_VIEW_FULL", +"PUBLISHER_MODEL_VERSION_VIEW_BASIC" +], +"enumDescriptions": [ +"The default / unset value. The API will default to the BASIC view.", +"Include basic metadata about the publisher model, but not the full contents.", +"Include everything.", +"Include: VersionId, ModelVersionExternalName, and SupportedActions." +], +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+parent}/models", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ListPublisherModelsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"predict": { +"description": "", +"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:predict", +"httpMethod": "POST", +"id": "aiplatform.publishers.models.predict", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"location": "path", +"pattern": "^publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+endpoint}:predict", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1PredictRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1PredictResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"predictLongRunning": { +"description": "", +"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:predictLongRunning", +"httpMethod": "POST", +"id": "aiplatform.publishers.models.predictLongRunning", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", +"location": "path", +"pattern": "^publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+endpoint}:predictLongRunning", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +}, +"streamGenerateContent": { +"description": "Generate content with multimodal inputs with streaming support.", +"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent", +"httpMethod": "POST", +"id": "aiplatform.publishers.models.streamGenerateContent", +"parameterOrder": [ +"model" +], +"parameters": { +"model": { +"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"location": "path", +"pattern": "^publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+model}:streamGenerateContent", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +} +} +} +} +}, +"ragCorpora": { +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.ragCorpora.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^ragCorpora/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.ragCorpora.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^ragCorpora/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.ragCorpora.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^ragCorpora/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations", +"httpMethod": "GET", +"id": "aiplatform.ragCorpora.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^ragCorpora/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.ragCorpora.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^ragCorpora/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"ragFiles": { +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.ragCorpora.ragFiles.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.ragCorpora.ragFiles.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.ragCorpora.ragFiles.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations", +"httpMethod": "GET", +"id": "aiplatform.ragCorpora.ragFiles.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.ragCorpora.ragFiles.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +}, +"ragEngineConfig": { +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/ragEngineConfig/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.ragEngineConfig.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^ragEngineConfig/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/ragEngineConfig/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.ragEngineConfig.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^ragEngineConfig/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta1/ragEngineConfig/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.ragEngineConfig.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^ragEngineConfig/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/ragEngineConfig/operations", +"httpMethod": "GET", +"id": "aiplatform.ragEngineConfig.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^ragEngineConfig$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/ragEngineConfig/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.ragEngineConfig.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^ragEngineConfig/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"reasoningEngines": { +"methods": { +"create": { +"description": "Creates a reasoning engine.", +"flatPath": "v1beta1/reasoningEngines", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.create", +"parameterOrder": [], +"parameters": { +"parent": { +"description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/reasoningEngines", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a reasoning engine.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}", +"httpMethod": "DELETE", +"id": "aiplatform.reasoningEngines.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"force": { +"description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"executeCode": { +"description": "Executes code statelessly.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}:executeCode", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.executeCode", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:executeCode", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1ExecuteCodeRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ExecuteCodeResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a reasoning engine.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists reasoning engines in a location.", +"flatPath": "v1beta1/reasoningEngines", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.list", +"parameterOrder": [], +"parameters": { +"filter": { +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The standard list page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/reasoningEngines", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a reasoning engine.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}", +"httpMethod": "PATCH", +"id": "aiplatform.reasoningEngines.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Mask specifying which fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"query": { +"description": "Queries using a reasoning engine.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}:query", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.query", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:query", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"streamQuery": { +"description": "Streams queries using a reasoning engine.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}:streamQuery", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.streamQuery", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:streamQuery", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1StreamQueryReasoningEngineRequest" +}, +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"a2a": { +"methods": { +"card": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/card", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.a2a.card", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^card$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"extendedAgentCard": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/extendedAgentCard", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.a2a.extendedAgentCard", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^extendedAgentCard$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"tasks": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.a2a.tasks", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^tasks$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"message": { +"methods": { +"send": { +"description": "Send post request for reasoning engine instance via the A2A post protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/message:send", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.a2a.message.send", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", +"location": "path", +"pattern": "^message$", +"required": true, +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send", +"request": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"stream": { +"description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/message:stream", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.a2a.message.stream", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.", +"location": "path", +"pattern": "^message$", +"required": true, +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream", +"request": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"tasks": { +"methods": { +"a2aGetReasoningEngine": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.a2a.tasks.a2aGetReasoningEngine", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^tasks/[^/]+$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"cancel": { +"description": "Send post request for reasoning engine instance via the A2A post protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.a2a.tasks.cancel", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", +"location": "path", +"pattern": "^tasks/[^/]+$", +"required": true, +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel", +"request": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"pushNotificationConfigs": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}/pushNotificationConfigs", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.a2a.tasks.pushNotificationConfigs", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^tasks/[^/]+/pushNotificationConfigs$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"subscribe": { +"description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}:subscribe", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.a2a.tasks.subscribe", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.", +"location": "path", +"pattern": "^tasks/[^/]+$", +"required": true, +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe", +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"pushNotificationConfigs": { +"methods": { +"a2aGetReasoningEngine": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.a2a.tasks.pushNotificationConfigs.a2aGetReasoningEngine", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^tasks/[^/]+/pushNotificationConfigs/[^/]+$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"v1": { +"methods": { +"card": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/card", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.a2a.v1.card", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^v1/card$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"extendedAgentCard": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/extendedAgentCard", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.a2a.v1.extendedAgentCard", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^v1/extendedAgentCard$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"tasks": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.a2a.v1.tasks", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^v1/tasks$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"message": { +"methods": { +"send": { +"description": "Send post request for reasoning engine instance via the A2A post protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:send", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.a2a.v1.message.send", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", +"location": "path", +"pattern": "^v1/message$", +"required": true, +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send", +"request": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"stream": { +"description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:stream", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.a2a.v1.message.stream", "parameterOrder": [ -"endpoint" +"name", +"a2aEndpoint" ], "parameters": { -"endpoint": { -"description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.", +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.", "location": "path", -"pattern": "^publishers/[^/]+/models/[^/]+$", +"pattern": "^v1/message$", +"required": true, +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+endpoint}:computeTokens", +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream", "request": { -"$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest" +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"tasks": { +"methods": { +"a2aGetReasoningEngine": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.a2a.v1.tasks.a2aGetReasoningEngine", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^v1/tasks/[^/]+$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"cancel": { +"description": "Send post request for reasoning engine instance via the A2A post protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.a2a.v1.tasks.cancel", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", +"location": "path", +"pattern": "^v1/tasks/[^/]+$", +"required": true, +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel", +"request": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"pushNotificationConfigs": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^v1/tasks/[^/]+/pushNotificationConfigs$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"subscribe": { +"description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:subscribe", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.a2a.v1.tasks.subscribe", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.", +"location": "path", +"pattern": "^v1/tasks/[^/]+$", +"required": true, +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe", +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"pushNotificationConfigs": { +"methods": { +"a2aGetReasoningEngine": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^v1/tasks/[^/]+/pushNotificationConfigs/[^/]+$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +}, +"examples": { +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.examples.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.reasoningEngines.examples.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.examples.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.examples.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"feedbackEntries": { +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.feedbackEntries.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.reasoningEngines.feedbackEntries.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.feedbackEntries.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.feedbackEntries.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/feedbackEntries/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.feedbackEntries.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} }, +"path": "v1beta1/{+name}:wait", "response": { -"$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} +} +} }, -"countTokens": { -"description": "Perform a token counting.", -"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:countTokens", +"memories": { +"methods": { +"create": { +"description": "Create a Memory.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories", "httpMethod": "POST", -"id": "aiplatform.publishers.models.countTokens", +"id": "aiplatform.reasoningEngines.memories.create", "parameterOrder": [ -"endpoint" +"parent" ], "parameters": { -"endpoint": { -"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"memoryId": { +"description": "Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^publishers/[^/]+/models/[^/]+$", +"pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+endpoint}:countTokens", +"path": "v1beta1/{+parent}/memories", "request": { -"$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest" +"$ref": "GoogleCloudAiplatformV1beta1Memory" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, -"fetchPredictOperation": { -"description": "Fetch an asynchronous online prediction operation.", -"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation", -"httpMethod": "POST", -"id": "aiplatform.publishers.models.fetchPredictOperation", +"delete": { +"description": "Delete a Memory.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", +"httpMethod": "DELETE", +"id": "aiplatform.reasoningEngines.memories.delete", "parameterOrder": [ -"endpoint" +"name" ], "parameters": { -"endpoint": { -"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", +"name": { +"description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", -"pattern": "^publishers/[^/]+/models/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+endpoint}:fetchPredictOperation", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest" -}, +"path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, -"generateContent": { -"description": "Generate content with multimodal inputs.", -"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:generateContent", +"generate": { +"description": "Generate memories.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:generate", "httpMethod": "POST", -"id": "aiplatform.publishers.models.generateContent", +"id": "aiplatform.reasoningEngines.memories.generate", "parameterOrder": [ -"model" +"parent" ], "parameters": { -"model": { -"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"parent": { +"description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^publishers/[^/]+/models/[^/]+$", +"pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+model}:generateContent", +"path": "v1beta1/{+parent}/memories:generate", "request": { -"$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" +"$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets a Model Garden publisher model.", -"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}", +"description": "Get a Memory.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", "httpMethod": "GET", -"id": "aiplatform.publishers.models.get", +"id": "aiplatform.reasoningEngines.memories.get", "parameterOrder": [ "name" ], "parameters": { -"huggingFaceToken": { -"description": "Optional. Token used to access Hugging Face gated models.", -"location": "query", -"type": "string" -}, -"includeEquivalentModelGardenModelDeploymentConfigs": { -"description": "Optional. Whether to cnclude the deployment configs from the equivalent Model Garden model if the requested model is a Hugging Face model.", -"location": "query", -"type": "boolean" -}, -"isHuggingFaceModel": { -"description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.", -"location": "query", -"type": "boolean" -}, -"languageCode": { -"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.", -"location": "query", -"type": "string" -}, "name": { -"description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`", +"description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", -"pattern": "^publishers/[^/]+/models/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", "required": true, "type": "string" +} }, -"view": { -"description": "Optional. PublisherModel view specifying which fields to read.", -"enum": [ -"PUBLISHER_MODEL_VIEW_UNSPECIFIED", -"PUBLISHER_MODEL_VIEW_BASIC", -"PUBLISHER_MODEL_VIEW_FULL", -"PUBLISHER_MODEL_VERSION_VIEW_BASIC" -], -"enumDescriptions": [ -"The default / unset value. The API will default to the BASIC view.", -"Include basic metadata about the publisher model, but not the full contents.", -"Include everything.", -"Include: VersionId, ModelVersionExternalName, and SupportedActions." +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1Memory" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"ingestEvents": { +"description": "Ingests events for a Memory Bank.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:ingestEvents", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.memories.ingestEvents", +"parameterOrder": [ +"parent" ], -"location": "query", +"parameters": { +"parent": { +"description": "Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, "type": "string" } }, -"path": "v1beta1/{+name}", +"path": "v1beta1/{+parent}/memories:ingestEvents", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1IngestEventsRequest" +}, "response": { -"$ref": "GoogleCloudAiplatformV1beta1PublisherModel" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists publisher models in Model Garden.", -"flatPath": "v1beta1/publishers/{publishersId}/models", +"description": "List Memories.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories", "httpMethod": "GET", -"id": "aiplatform.publishers.models.list", +"id": "aiplatform.reasoningEngines.memories.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { -"description": "Optional. The standard list filter.", -"location": "query", -"type": "string" -}, -"languageCode": { -"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in. If not set, by default English (en).", +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: \"example topic\" OR topics.managed_memory_topic: USER_PREFERENCES`)", "location": "query", "type": "string" }, -"listAllVersions": { -"description": "Optional. List all publisher model versions if the flag is set to true.", -"location": "query", -"type": "boolean" -}, "orderBy": { -"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", +"description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`", "location": "query", "type": "string" }, @@ -35891,143 +39995,181 @@ "type": "integer" }, "pageToken": { -"description": "Optional. The standard list page token. Typically obtained via ListPublisherModelsResponse.next_page_token of the previous ModelGardenService.ListPublisherModels call.", +"description": "Optional. The standard list page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The name of the Publisher from which to list the PublisherModels. Format: `publishers/{publisher}`", +"description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^publishers/[^/]+$", +"pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" +} }, -"view": { -"description": "Optional. PublisherModel view specifying which fields to read.", -"enum": [ -"PUBLISHER_MODEL_VIEW_UNSPECIFIED", -"PUBLISHER_MODEL_VIEW_BASIC", -"PUBLISHER_MODEL_VIEW_FULL", -"PUBLISHER_MODEL_VERSION_VIEW_BASIC" -], -"enumDescriptions": [ -"The default / unset value. The API will default to the BASIC view.", -"Include basic metadata about the publisher model, but not the full contents.", -"Include everything.", -"Include: VersionId, ModelVersionExternalName, and SupportedActions." +"path": "v1beta1/{+parent}/memories", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ListMemoriesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Update a Memory.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", +"httpMethod": "PATCH", +"id": "aiplatform.reasoningEngines.memories.patch", +"parameterOrder": [ +"name" ], +"parameters": { +"name": { +"description": "Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`", +"format": "google-fieldmask", "location": "query", "type": "string" } }, -"path": "v1beta1/{+parent}/models", +"path": "v1beta1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1Memory" +}, "response": { -"$ref": "GoogleCloudAiplatformV1beta1ListPublisherModelsResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"predict": { -"description": "", -"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:predict", +"purge": { +"description": "Purge memories.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:purge", "httpMethod": "POST", -"id": "aiplatform.publishers.models.predict", +"id": "aiplatform.reasoningEngines.memories.purge", "parameterOrder": [ -"endpoint" +"parent" ], "parameters": { -"endpoint": { -"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"parent": { +"description": "Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^publishers/[^/]+/models/[^/]+$", +"pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+endpoint}:predict", +"path": "v1beta1/{+parent}/memories:purge", "request": { -"$ref": "GoogleCloudAiplatformV1beta1PredictRequest" +"$ref": "GoogleCloudAiplatformV1beta1PurgeMemoriesRequest" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1PredictResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, -"predictLongRunning": { -"description": "", -"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:predictLongRunning", +"retrieve": { +"description": "Retrieve memories.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:retrieve", "httpMethod": "POST", -"id": "aiplatform.publishers.models.predictLongRunning", +"id": "aiplatform.reasoningEngines.memories.retrieve", "parameterOrder": [ -"endpoint" +"parent" ], "parameters": { -"endpoint": { -"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`", +"parent": { +"description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^publishers/[^/]+/models/[^/]+$", +"pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+endpoint}:predictLongRunning", +"path": "v1beta1/{+parent}/memories:retrieve", "request": { -"$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest" +"$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest" }, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, -"streamGenerateContent": { -"description": "Generate content with multimodal inputs with streaming support.", -"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent", +"retrieveProfiles": { +"description": "Retrieves profiles.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:retrieveProfiles", "httpMethod": "POST", -"id": "aiplatform.publishers.models.streamGenerateContent", +"id": "aiplatform.reasoningEngines.memories.retrieveProfiles", "parameterOrder": [ -"model" +"parent" ], "parameters": { -"model": { -"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"parent": { +"description": "Required. The resource name of the ReasoningEngine to retrieve profiles from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^publishers/[^/]+/models/[^/]+$", +"pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+model}:streamGenerateContent", +"path": "v1beta1/{+parent}/memories:retrieveProfiles", "request": { -"$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest" +"$ref": "GoogleCloudAiplatformV1beta1RetrieveProfilesRequest" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse" +"$ref": "GoogleCloudAiplatformV1beta1RetrieveProfilesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] +}, +"rollback": { +"description": "Rollback Memory to a specific revision.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}:rollback", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.memories.rollback", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", +"required": true, +"type": "string" } -} -} +}, +"path": "v1beta1/{+name}:rollback", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1RollbackMemoryRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, -"ragCorpora": { "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.ragCorpora.operations.cancel", +"id": "aiplatform.reasoningEngines.memories.operations.cancel", "parameterOrder": [ "name" ], @@ -36035,7 +40177,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^ragCorpora/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -36050,9 +40192,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations/{operationsId}", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.ragCorpora.operations.delete", +"id": "aiplatform.reasoningEngines.memories.operations.delete", "parameterOrder": [ "name" ], @@ -36060,7 +40202,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^ragCorpora/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -36075,9 +40217,9 @@ }, "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": "v1beta1/ragCorpora/{ragCorporaId}/operations/{operationsId}", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.ragCorpora.operations.get", +"id": "aiplatform.reasoningEngines.memories.operations.get", "parameterOrder": [ "name" ], @@ -36085,7 +40227,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^ragCorpora/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -36100,9 +40242,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations", "httpMethod": "GET", -"id": "aiplatform.ragCorpora.operations.list", +"id": "aiplatform.reasoningEngines.memories.operations.list", "parameterOrder": [ "name" ], @@ -36115,7 +40257,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^ragCorpora/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", "required": true, "type": "string" }, @@ -36146,9 +40288,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.ragCorpora.operations.wait", +"id": "aiplatform.reasoningEngines.memories.operations.wait", "parameterOrder": [ "name" ], @@ -36156,7 +40298,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^ragCorpora/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -36177,157 +40319,69 @@ } } }, -"ragFiles": { -"resources": { -"operations": { +"revisions": { "methods": { -"cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel", -"httpMethod": "POST", -"id": "aiplatform.ragCorpora.ragFiles.operations.cancel", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", -"location": "path", -"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}:cancel", -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", -"httpMethod": "DELETE", -"id": "aiplatform.ragCorpora.ragFiles.operations.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to be deleted.", -"location": "path", -"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}", +"description": "Get a Memory Revision.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/revisions/{revisionsId}", "httpMethod": "GET", -"id": "aiplatform.ragCorpora.ragFiles.operations.get", +"id": "aiplatform.reasoningEngines.memories.revisions.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}`", "location": "path", -"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/revisions/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1beta1MemoryRevision" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations", +"description": "List Memory Revisions for a Memory.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/revisions", "httpMethod": "GET", -"id": "aiplatform.ragCorpora.ragFiles.operations.list", +"id": "aiplatform.reasoningEngines.memories.revisions.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { "filter": { -"description": "The standard list filter.", +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`", "location": "query", "type": "string" }, -"name": { -"description": "The name of the operation's parent resource.", -"location": "path", -"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+$", -"required": true, -"type": "string" -}, "pageSize": { -"description": "The standard list page size.", +"description": "Optional. The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token.", +"description": "Optional. The standard list page token.", "location": "query", "type": "string" }, -"returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1beta1/{+name}/operations", -"response": { -"$ref": "GoogleLongrunningListOperationsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait", -"httpMethod": "POST", -"id": "aiplatform.ragCorpora.ragFiles.operations.wait", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to wait on.", +"parent": { +"description": "Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", -"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", "required": true, "type": "string" -}, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", -"location": "query", -"type": "string" } }, -"path": "v1beta1/{+name}:wait", +"path": "v1beta1/{+parent}/revisions", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1beta1ListMemoryRevisionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -36336,18 +40390,14 @@ } } } -} -} }, -"ragEngineConfig": { -"resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/ragEngineConfig/operations/{operationsId}:cancel", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.ragEngineConfig.operations.cancel", +"id": "aiplatform.reasoningEngines.operations.cancel", "parameterOrder": [ "name" ], @@ -36355,7 +40405,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^ragEngineConfig/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -36370,9 +40420,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/ragEngineConfig/operations/{operationsId}", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.ragEngineConfig.operations.delete", +"id": "aiplatform.reasoningEngines.operations.delete", "parameterOrder": [ "name" ], @@ -36380,7 +40430,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^ragEngineConfig/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -36395,9 +40445,9 @@ }, "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": "v1beta1/ragEngineConfig/operations/{operationsId}", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.ragEngineConfig.operations.get", +"id": "aiplatform.reasoningEngines.operations.get", "parameterOrder": [ "name" ], @@ -36405,7 +40455,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^ragEngineConfig/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -36420,9 +40470,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/ragEngineConfig/operations", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations", "httpMethod": "GET", -"id": "aiplatform.ragEngineConfig.operations.list", +"id": "aiplatform.reasoningEngines.operations.list", "parameterOrder": [ "name" ], @@ -36435,7 +40485,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^ragEngineConfig$", +"pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" }, @@ -36466,9 +40516,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/ragEngineConfig/operations/{operationsId}:wait", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.ragEngineConfig.operations.wait", +"id": "aiplatform.reasoningEngines.operations.wait", "parameterOrder": [ "name" ], @@ -36476,7 +40526,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^ragEngineConfig/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -36496,194 +40546,14 @@ ] } } -} -} }, -"reasoningEngines": { +"runtimeRevisions": { "methods": { -"create": { -"description": "Creates a reasoning engine.", -"flatPath": "v1beta1/reasoningEngines", -"httpMethod": "POST", -"id": "aiplatform.reasoningEngines.create", -"parameterOrder": [], -"parameters": { -"parent": { -"description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`", -"location": "query", -"type": "string" -} -}, -"path": "v1beta1/reasoningEngines", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Deletes a reasoning engine.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}", -"httpMethod": "DELETE", -"id": "aiplatform.reasoningEngines.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"force": { -"description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.", -"location": "query", -"type": "boolean" -}, -"name": { -"description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", -"location": "path", -"pattern": "^reasoningEngines/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"executeCode": { -"description": "Executes code statelessly.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}:executeCode", -"httpMethod": "POST", -"id": "aiplatform.reasoningEngines.executeCode", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", -"location": "path", -"pattern": "^reasoningEngines/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}:executeCode", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1ExecuteCodeRequest" -}, -"response": { -"$ref": "GoogleCloudAiplatformV1beta1ExecuteCodeResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Gets a reasoning engine.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}", -"httpMethod": "GET", -"id": "aiplatform.reasoningEngines.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", -"location": "path", -"pattern": "^reasoningEngines/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists reasoning engines in a location.", -"flatPath": "v1beta1/reasoningEngines", -"httpMethod": "GET", -"id": "aiplatform.reasoningEngines.list", -"parameterOrder": [], -"parameters": { -"filter": { -"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. The standard list page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`", -"location": "query", -"type": "string" -} -}, -"path": "v1beta1/reasoningEngines", -"response": { -"$ref": "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"patch": { -"description": "Updates a reasoning engine.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}", -"httpMethod": "PATCH", -"id": "aiplatform.reasoningEngines.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", -"location": "path", -"pattern": "^reasoningEngines/[^/]+$", -"required": true, -"type": "string" -}, -"updateMask": { -"description": "Optional. Mask specifying which fields to update.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "query": { "description": "Queries using a reasoning engine.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}:query", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:query", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.query", +"id": "aiplatform.reasoningEngines.runtimeRevisions.query", "parameterOrder": [ "name" ], @@ -36691,7 +40561,7 @@ "name": { "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -36709,9 +40579,9 @@ }, "streamQuery": { "description": "Streams queries using a reasoning engine.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}:streamQuery", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}:streamQuery", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.streamQuery", +"id": "aiplatform.reasoningEngines.runtimeRevisions.streamQuery", "parameterOrder": [ "name" ], @@ -36719,7 +40589,7 @@ "name": { "description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -36741,9 +40611,9 @@ "methods": { "card": { "description": "Get request for reasoning engine instance via the A2A get protocol apis.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/card", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/card", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.a2a.card", +"id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.card", "parameterOrder": [ "name", "a2aEndpoint" @@ -36764,7 +40634,7 @@ "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -36783,9 +40653,9 @@ }, "extendedAgentCard": { "description": "Get request for reasoning engine instance via the A2A get protocol apis.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/extendedAgentCard", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/extendedAgentCard", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.a2a.extendedAgentCard", +"id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.extendedAgentCard", "parameterOrder": [ "name", "a2aEndpoint" @@ -36806,7 +40676,7 @@ "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -36825,9 +40695,9 @@ }, "tasks": { "description": "Get request for reasoning engine instance via the A2A get protocol apis.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.a2a.tasks", +"id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.tasks", "parameterOrder": [ "name", "a2aEndpoint" @@ -36848,7 +40718,7 @@ "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -36871,9 +40741,9 @@ "methods": { "send": { "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/message:send", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/message:send", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.a2a.message.send", +"id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.message.send", "parameterOrder": [ "name", "a2aEndpoint" @@ -36889,7 +40759,7 @@ "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -36915,9 +40785,9 @@ }, "stream": { "description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/message:stream", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/message:stream", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.a2a.message.stream", +"id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.message.stream", "parameterOrder": [ "name", "a2aEndpoint" @@ -36933,7 +40803,7 @@ "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -36959,9 +40829,9 @@ "methods": { "a2aGetReasoningEngine": { "description": "Get request for reasoning engine instance via the A2A get protocol apis.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.a2a.tasks.a2aGetReasoningEngine", +"id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.tasks.a2aGetReasoningEngine", "parameterOrder": [ "name", "a2aEndpoint" @@ -36982,7 +40852,7 @@ "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -37001,9 +40871,9 @@ }, "cancel": { "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}:cancel", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}:cancel", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.a2a.tasks.cancel", +"id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.tasks.cancel", "parameterOrder": [ "name", "a2aEndpoint" @@ -37019,7 +40889,7 @@ "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -37045,9 +40915,9 @@ }, "pushNotificationConfigs": { "description": "Get request for reasoning engine instance via the A2A get protocol apis.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}/pushNotificationConfigs", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}/pushNotificationConfigs", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.a2a.tasks.pushNotificationConfigs", +"id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.tasks.pushNotificationConfigs", "parameterOrder": [ "name", "a2aEndpoint" @@ -37068,7 +40938,7 @@ "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -37087,9 +40957,9 @@ }, "subscribe": { "description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}:subscribe", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}:subscribe", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.a2a.tasks.subscribe", +"id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.tasks.subscribe", "parameterOrder": [ "name", "a2aEndpoint" @@ -37105,7 +40975,7 @@ "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -37124,9 +40994,9 @@ "methods": { "a2aGetReasoningEngine": { "description": "Get request for reasoning engine instance via the A2A get protocol apis.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.a2a.tasks.pushNotificationConfigs.a2aGetReasoningEngine", +"id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.tasks.pushNotificationConfigs.a2aGetReasoningEngine", "parameterOrder": [ "name", "a2aEndpoint" @@ -37147,7 +41017,7 @@ "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -37172,9 +41042,9 @@ "methods": { "card": { "description": "Get request for reasoning engine instance via the A2A get protocol apis.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/card", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/card", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.a2a.v1.card", +"id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.card", "parameterOrder": [ "name", "a2aEndpoint" @@ -37195,7 +41065,7 @@ "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -37214,9 +41084,9 @@ }, "extendedAgentCard": { "description": "Get request for reasoning engine instance via the A2A get protocol apis.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/extendedAgentCard", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/extendedAgentCard", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.a2a.v1.extendedAgentCard", +"id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.extendedAgentCard", "parameterOrder": [ "name", "a2aEndpoint" @@ -37237,7 +41107,7 @@ "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -37256,9 +41126,9 @@ }, "tasks": { "description": "Get request for reasoning engine instance via the A2A get protocol apis.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.a2a.v1.tasks", +"id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.tasks", "parameterOrder": [ "name", "a2aEndpoint" @@ -37279,7 +41149,7 @@ "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -37302,9 +41172,9 @@ "methods": { "send": { "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:send", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/message:send", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.a2a.v1.message.send", +"id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.message.send", "parameterOrder": [ "name", "a2aEndpoint" @@ -37320,7 +41190,7 @@ "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -37346,9 +41216,9 @@ }, "stream": { "description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:stream", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/message:stream", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.a2a.v1.message.stream", +"id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.message.stream", "parameterOrder": [ "name", "a2aEndpoint" @@ -37364,7 +41234,7 @@ "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -37390,9 +41260,9 @@ "methods": { "a2aGetReasoningEngine": { "description": "Get request for reasoning engine instance via the A2A get protocol apis.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.a2a.v1.tasks.a2aGetReasoningEngine", +"id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.tasks.a2aGetReasoningEngine", "parameterOrder": [ "name", "a2aEndpoint" @@ -37413,7 +41283,7 @@ "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -37432,9 +41302,9 @@ }, "cancel": { "description": "Send post request for reasoning engine instance via the A2A post protocol apis.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:cancel", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}:cancel", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.a2a.v1.tasks.cancel", +"id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.tasks.cancel", "parameterOrder": [ "name", "a2aEndpoint" @@ -37450,7 +41320,7 @@ "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -37476,9 +41346,9 @@ }, "pushNotificationConfigs": { "description": "Get request for reasoning engine instance via the A2A get protocol apis.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs", +"id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.tasks.pushNotificationConfigs", "parameterOrder": [ "name", "a2aEndpoint" @@ -37499,7 +41369,7 @@ "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -37518,9 +41388,9 @@ }, "subscribe": { "description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:subscribe", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}:subscribe", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.a2a.v1.tasks.subscribe", +"id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.tasks.subscribe", "parameterOrder": [ "name", "a2aEndpoint" @@ -37536,7 +41406,7 @@ "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL.", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -37555,9 +41425,9 @@ "methods": { "a2aGetReasoningEngine": { "description": "Get request for reasoning engine instance via the A2A get protocol apis.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine", +"id": "aiplatform.reasoningEngines.runtimeRevisions.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine", "parameterOrder": [ "name", "a2aEndpoint" @@ -37578,7 +41448,7 @@ "name": { "description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" } @@ -37603,129 +41473,13 @@ } } }, -"examples": { -"resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:cancel", -"httpMethod": "POST", -"id": "aiplatform.reasoningEngines.examples.operations.cancel", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", -"location": "path", -"pattern": "^reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}:cancel", -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}", -"httpMethod": "DELETE", -"id": "aiplatform.reasoningEngines.examples.operations.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to be deleted.", -"location": "path", -"pattern": "^reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}", -"httpMethod": "GET", -"id": "aiplatform.reasoningEngines.examples.operations.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource.", -"location": "path", -"pattern": "^reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:wait", -"httpMethod": "POST", -"id": "aiplatform.reasoningEngines.examples.operations.wait", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to wait on.", -"location": "path", -"pattern": "^reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$", -"required": true, -"type": "string" -}, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", -"location": "query", -"type": "string" -} -}, -"path": "v1beta1/{+name}:wait", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -} -} -}, -"feedbackEntries": { -"resources": { -"operations": { -"methods": { -"cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.feedbackEntries.operations.cancel", +"id": "aiplatform.reasoningEngines.runtimeRevisions.operations.cancel", "parameterOrder": [ "name" ], @@ -37733,7 +41487,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -37748,9 +41502,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.reasoningEngines.feedbackEntries.operations.delete", +"id": "aiplatform.reasoningEngines.runtimeRevisions.operations.delete", "parameterOrder": [ "name" ], @@ -37758,7 +41512,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -37773,9 +41527,9 @@ }, "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": "v1beta1/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.feedbackEntries.operations.get", +"id": "aiplatform.reasoningEngines.runtimeRevisions.operations.get", "parameterOrder": [ "name" ], @@ -37783,7 +41537,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -37798,9 +41552,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.feedbackEntries.operations.list", +"id": "aiplatform.reasoningEngines.runtimeRevisions.operations.list", "parameterOrder": [ "name" ], @@ -37813,7 +41567,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/feedbackEntries/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", "required": true, "type": "string" }, @@ -37844,9 +41598,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.feedbackEntries.operations.wait", +"id": "aiplatform.reasoningEngines.runtimeRevisions.operations.wait", "parameterOrder": [ "name" ], @@ -37854,7 +41608,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/feedbackEntries/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -37877,54 +41631,21 @@ } } }, -"memories": { +"sandboxEnvironmentSnapshots": { "methods": { -"create": { -"description": "Create a Memory.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories", -"httpMethod": "POST", -"id": "aiplatform.reasoningEngines.memories.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"memoryId": { -"description": "Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", -"location": "path", -"pattern": "^reasoningEngines/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+parent}/memories", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1Memory" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "delete": { -"description": "Delete a Memory.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", +"description": "Deletes the specific SandboxEnvironmentSnapshot.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}", "httpMethod": "DELETE", -"id": "aiplatform.reasoningEngines.memories.delete", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", +"description": "Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$", "required": true, "type": "string" } @@ -37937,218 +41658,67 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"generate": { -"description": "Generate memories.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:generate", -"httpMethod": "POST", -"id": "aiplatform.reasoningEngines.memories.generate", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", -"location": "path", -"pattern": "^reasoningEngines/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+parent}/memories:generate", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "get": { -"description": "Get a Memory.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", +"description": "Gets details of the specific SandboxEnvironmentSnapshot.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.memories.get", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", +"description": "Required. The resource name of the sandbox environment snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1Memory" +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSnapshot" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "List Memories.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories", +"description": "Lists SandboxEnvironmentSnapshots in a given reasoning engine.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.memories.list", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { -"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: \"example topic\" OR topics.managed_memory_topic: USER_PREFERENCES`)", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`", +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "pageSize": { -"description": "Optional. The standard list page size.", +"description": "Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. The standard list page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", -"location": "path", -"pattern": "^reasoningEngines/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+parent}/memories", -"response": { -"$ref": "GoogleCloudAiplatformV1beta1ListMemoriesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"patch": { -"description": "Update a Memory.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}", -"httpMethod": "PATCH", -"id": "aiplatform.reasoningEngines.memories.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", -"location": "path", -"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", -"required": true, -"type": "string" -}, -"updateMask": { -"description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`", -"format": "google-fieldmask", +"description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" -} }, -"path": "v1beta1/{+name}", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1Memory" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"purge": { -"description": "Purge memories.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:purge", -"httpMethod": "POST", -"id": "aiplatform.reasoningEngines.memories.purge", -"parameterOrder": [ -"parent" -], -"parameters": { "parent": { -"description": "Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", -"location": "path", -"pattern": "^reasoningEngines/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+parent}/memories:purge", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1PurgeMemoriesRequest" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"retrieve": { -"description": "Retrieve memories.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:retrieve", -"httpMethod": "POST", -"id": "aiplatform.reasoningEngines.memories.retrieve", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", "pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/memories:retrieve", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest" -}, -"response": { -"$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"rollback": { -"description": "Rollback Memory to a specific revision.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}:rollback", -"httpMethod": "POST", -"id": "aiplatform.reasoningEngines.memories.rollback", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", -"location": "path", -"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}:rollback", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1RollbackMemoryRequest" -}, +"path": "v1beta1/{+parent}/sandboxEnvironmentSnapshots", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentSnapshotsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -38160,9 +41730,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.memories.operations.cancel", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.cancel", "parameterOrder": [ "name" ], @@ -38170,7 +41740,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -38185,9 +41755,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.reasoningEngines.memories.operations.delete", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.delete", "parameterOrder": [ "name" ], @@ -38195,7 +41765,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -38210,9 +41780,9 @@ }, "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": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.memories.operations.get", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.get", "parameterOrder": [ "name" ], @@ -38220,7 +41790,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -38235,9 +41805,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.memories.operations.list", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.list", "parameterOrder": [ "name" ], @@ -38250,7 +41820,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+$", "required": true, "type": "string" }, @@ -38281,9 +41851,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentSnapshots/{sandboxEnvironmentSnapshotsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.memories.operations.wait", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.wait", "parameterOrder": [ "name" ], @@ -38291,7 +41861,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentSnapshots/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -38311,244 +41881,139 @@ ] } } -}, -"revisions": { -"methods": { -"get": { -"description": "Get a Memory Revision.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/revisions/{revisionsId}", -"httpMethod": "GET", -"id": "aiplatform.reasoningEngines.memories.revisions.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}`", -"location": "path", -"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/revisions/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleCloudAiplatformV1beta1MemoryRevision" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "List Memory Revisions for a Memory.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/revisions", -"httpMethod": "GET", -"id": "aiplatform.reasoningEngines.memories.revisions.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. The standard list page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", -"location": "path", -"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+parent}/revisions", -"response": { -"$ref": "GoogleCloudAiplatformV1beta1ListMemoryRevisionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} } } }, -"operations": { +"sandboxEnvironmentTemplates": { "methods": { -"cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel", +"create": { +"description": "Creates a SandboxEnvironmentTemplate in a given reasoning engine.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.operations.cancel", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", +"parent": { +"description": "Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}:cancel", +"path": "v1beta1/{+parent}/sandboxEnvironmentTemplates", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplate" +}, "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", +"description": "Deletes the specific SandboxEnvironmentTemplate.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}", "httpMethod": "DELETE", -"id": "aiplatform.reasoningEngines.operations.delete", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource to be deleted.", +"description": "Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}", +"description": "Gets details of the specific SandboxEnvironmentTemplate.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.operations.get", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. The resource name of the sandbox environment template. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplate" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations", +"description": "Lists SandboxEnvironmentTemplates in a given reasoning engine.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.operations.list", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { "filter": { -"description": "The standard list filter.", +"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, -"name": { -"description": "The name of the operation's parent resource.", -"location": "path", -"pattern": "^reasoningEngines/[^/]+$", -"required": true, -"type": "string" -}, "pageSize": { -"description": "The standard list page size.", +"description": "Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token.", +"description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, -"returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1beta1/{+name}/operations", -"response": { -"$ref": "GoogleLongrunningListOperationsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait", -"httpMethod": "POST", -"id": "aiplatform.reasoningEngines.operations.wait", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to wait on.", +"parent": { +"description": "Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", -"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+$", "required": true, "type": "string" -}, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", -"location": "query", -"type": "string" } }, -"path": "v1beta1/{+name}:wait", +"path": "v1beta1/{+parent}/sandboxEnvironmentTemplates", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentTemplatesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } -} }, -"runtimeRevisions": { "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.runtimeRevisions.operations.cancel", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.cancel", "parameterOrder": [ "name" ], @@ -38556,7 +42021,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -38571,9 +42036,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.reasoningEngines.runtimeRevisions.operations.delete", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.delete", "parameterOrder": [ "name" ], @@ -38581,7 +42046,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -38596,9 +42061,9 @@ }, "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": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.runtimeRevisions.operations.get", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.get", "parameterOrder": [ "name" ], @@ -38606,7 +42071,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -38621,9 +42086,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations", "httpMethod": "GET", -"id": "aiplatform.reasoningEngines.runtimeRevisions.operations.list", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.list", "parameterOrder": [ "name" ], @@ -38636,7 +42101,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$", "required": true, "type": "string" }, @@ -38667,9 +42132,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/runtimeRevisions/{runtimeRevisionsId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.reasoningEngines.runtimeRevisions.operations.wait", +"id": "aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.wait", "parameterOrder": [ "name" ], @@ -38677,7 +42142,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^reasoningEngines/[^/]+/runtimeRevisions/[^/]+/operations/[^/]+$", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -38848,6 +42313,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"snapshot": { +"description": "Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:snapshot", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.sandboxEnvironments.snapshot", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:snapshot", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSnapshot" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -41210,7 +44703,7 @@ } } }, -"revision": "20260329", +"revision": "20260410", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { @@ -41879,6 +45372,17 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ActivateOnlineEvaluatorOperationMetadata": { +"description": "Metadata for the ActivateOnlineEvaluator operation.", +"id": "GoogleCloudAiplatformV1beta1ActivateOnlineEvaluatorOperationMetadata", +"properties": { +"genericMetadata": { +"$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", +"description": "Common part of operation metadata." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ActivateOnlineEvaluatorRequest": { "description": "Request message for ActivateOnlineEvaluator.", "id": "GoogleCloudAiplatformV1beta1ActivateOnlineEvaluatorRequest", @@ -45382,6 +48886,17 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1CreateOnlineEvaluatorOperationMetadata": { +"description": "Metadata for the CreateOnlineEvaluator operation.", +"id": "GoogleCloudAiplatformV1beta1CreateOnlineEvaluatorOperationMetadata", +"properties": { +"genericMetadata": { +"$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", +"description": "Common part of operation metadata." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1CreatePersistentResourceOperationMetadata": { "description": "Details of operations that perform create PersistentResource.", "id": "GoogleCloudAiplatformV1beta1CreatePersistentResourceOperationMetadata", @@ -46493,6 +50008,17 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1DeleteOnlineEvaluatorOperationMetadata": { +"description": "Metadata for the DeleteOnlineEvaluator operation.", +"id": "GoogleCloudAiplatformV1beta1DeleteOnlineEvaluatorOperationMetadata", +"properties": { +"genericMetadata": { +"$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", +"description": "Generic operation metadata." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1DeleteOperationMetadata": { "description": "Details of operations that perform deletes of any entities.", "id": "GoogleCloudAiplatformV1beta1DeleteOperationMetadata", @@ -46504,6 +50030,17 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1DeleteReasoningEngineRuntimeRevisionOperationMetadata": { +"description": "Metadata associated with DeleteReasoningEngineRuntimeRevision operation.", +"id": "GoogleCloudAiplatformV1beta1DeleteReasoningEngineRuntimeRevisionOperationMetadata", +"properties": { +"genericMetadata": { +"$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", +"description": "The common part of the operation metadata." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1DeployIndexOperationMetadata": { "description": "Runtime operation information for IndexEndpointService.DeployIndex.", "id": "GoogleCloudAiplatformV1beta1DeployIndexOperationMetadata", @@ -48759,7 +52296,7 @@ }, "metric": { "$ref": "GoogleCloudAiplatformV1beta1Metric", -"description": "Optional. The metric configuration." +"description": "Optional. The metric configuration. Only LLMMetric and CustomCodeExecutionMetric are supported." }, "name": { "description": "Identifier. The resource name of the EvaluationMetric. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}`", @@ -48774,6 +52311,28 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1EvaluationParserConfig": { +"description": "Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters.", +"id": "GoogleCloudAiplatformV1beta1EvaluationParserConfig", +"properties": { +"customCodeParserConfig": { +"$ref": "GoogleCloudAiplatformV1beta1EvaluationParserConfigCustomCodeParserConfig", +"description": "Optional. Use custom code to parse the LLM response." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1EvaluationParserConfigCustomCodeParserConfig": { +"description": "Configuration for parsing the LLM response using custom code.", +"id": "GoogleCloudAiplatformV1beta1EvaluationParserConfigCustomCodeParserConfig", +"properties": { +"parsingFunction": { +"description": "Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { \"content\": {\"property\": {\"description\": \"The response is factual.\"}}, \"type\": \"FACTUALITY\", \"importance\": \"HIGH\" }, { \"content\": {\"property\": {\"description\": \"The response is fluent.\"}}, \"type\": \"FLUENCY\", \"importance\": \"MEDIUM\" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { \"score\": 0.8, \"explanation\": \"The model followed most instructions.\", \"rubric_verdicts\": [...] } ... code for result extraction and aggregation", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1EvaluationPrompt": { "description": "Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations.", "id": "GoogleCloudAiplatformV1beta1EvaluationPrompt", @@ -49169,6 +52728,11 @@ "model": { "description": "Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "type": "string" +}, +"parallelism": { +"description": "Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used.", +"format": "int32", +"type": "integer" } }, "type": "object" @@ -49467,6 +53031,13 @@ "description": "EvaluationSet is a collection of related EvaluationItems that are evaluated together.", "id": "GoogleCloudAiplatformV1beta1EvaluationSet", "properties": { +"agentConfigs": { +"additionalProperties": { +"$ref": "GoogleCloudAiplatformV1beta1AgentConfig" +}, +"description": "Optional. Static configurations for each agent associated with the items in this set. Key: `agent_id` (matches the `author` field in `events`). Value: The static configuration of the agent.", +"type": "object" +}, "createTime": { "description": "Output only. Timestamp when this item was created.", "format": "google-datetime", @@ -50883,12 +54454,12 @@ "type": "string" }, "projectId": { -"description": "Output only. The project ID of the project.", +"description": "Output only. The ID of the project.", "readOnly": true, "type": "string" }, "projectNumber": { -"description": "Output only. The project number of the project.", +"description": "Output only. The number of the project.", "format": "int64", "readOnly": true, "type": "string" @@ -54071,6 +57642,13 @@ "description": "Request message for MemoryBankService.GenerateMemories. Maximum size is 8 MB.", "id": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest", "properties": { +"allowedTopics": { +"description": "Optional. Restricts memory generation to a subset of memory topics.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1MemoryTopicId" +}, +"type": "array" +}, "directContentsSource": { "$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectContentsSource", "description": "Defines a direct source of content as the source content from which to generate memories." @@ -56089,6 +59667,70 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1IngestEventsRequest": { +"description": "Request message for MemoryBankService.IngestEvents.", +"id": "GoogleCloudAiplatformV1beta1IngestEventsRequest", +"properties": { +"directContentsSource": { +"$ref": "GoogleCloudAiplatformV1beta1IngestionDirectContentsSource", +"description": "Ingest events directly from the request." +}, +"forceFlush": { +"description": "Optional. Forces a flush of all pending events in the stream and triggers memory generation immediately bypassing any conditions configured in the `generation_trigger_config`.", +"type": "boolean" +}, +"generationTriggerConfig": { +"$ref": "GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfig", +"description": "Optional. Configuration for triggering memory generation from this ingestion. If not set, then the stream will be force flushed immediately." +}, +"scope": { +"additionalProperties": { +"type": "string" +}, +"description": "Required. The scope of the memories that should be generated from the stream. Memories will be consolidated across memories with the same scope. Scope values cannot contain the wildcard character '*'.", +"type": "object" +}, +"streamId": { +"description": "Optional. The ID of the stream to ingest events into. If not provided, a new one will be created.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1IngestionDirectContentsSource": { +"description": "Ingest events directly from the request.", +"id": "GoogleCloudAiplatformV1beta1IngestionDirectContentsSource", +"properties": { +"events": { +"description": "Required. The events to ingest.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1IngestionDirectContentsSourceEvent" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1IngestionDirectContentsSourceEvent": { +"description": "A single event to ingest.", +"id": "GoogleCloudAiplatformV1beta1IngestionDirectContentsSourceEvent", +"properties": { +"content": { +"$ref": "GoogleCloudAiplatformV1beta1Content", +"description": "Required. The content of the event." +}, +"eventId": { +"description": "Optional. A unique identifier for the event. If an event with the same event_id is ingested multiple times, it will be de-duplicated.", +"type": "string" +}, +"eventTime": { +"description": "Optional. The time at which the event occurred. If provided, this timestamp will be used for ordering events within a stream. If not provided, the server-side ingestion time will be used.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1InputDataConfig": { "description": "Specifies Vertex AI owned input data to be used for training, and possibly evaluating, the Model.", "id": "GoogleCloudAiplatformV1beta1InputDataConfig", @@ -56183,10 +59825,24 @@ "description": "An extracted memory that is the intermediate result before consolidation.", "id": "GoogleCloudAiplatformV1beta1IntermediateExtractedMemory", "properties": { +"context": { +"description": "Output only. Represents the explanation of why the information was extracted from the source content.", +"readOnly": true, +"type": "string" +}, "fact": { -"description": "Output only. The fact of the extracted memory.", +"description": "Output only. Represents the fact of the extracted memory.", "readOnly": true, "type": "string" +}, +"structuredData": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Output only. Represents the structured value of the extracted memory.", +"readOnly": true, +"type": "object" } }, "type": "object" @@ -56362,6 +60018,10 @@ "$ref": "GoogleCloudAiplatformV1beta1PredefinedMetricSpec", "description": "Dynamically generate rubrics using a predefined spec." }, +"resultParserConfig": { +"$ref": "GoogleCloudAiplatformV1beta1EvaluationParserConfig", +"description": "Optional. The parser config for the metric result." +}, "rubricGenerationSpec": { "$ref": "GoogleCloudAiplatformV1beta1RubricGenerationSpec", "description": "Dynamically generate rubrics using this specification." @@ -57497,6 +61157,24 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ListReasoningEngineRuntimeRevisionsResponse": { +"description": "Response message for ReasoningEngineRuntimeRevisionService.ListReasoningEngineRuntimeRevisions", +"id": "GoogleCloudAiplatformV1beta1ListReasoningEngineRuntimeRevisionsResponse", +"properties": { +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass to ListReasoningEngineRuntimeRevisionsRequest.page_token to obtain that page.", +"type": "string" +}, +"reasoningEngineRuntimeRevisions": { +"description": "List of ReasoningEngineRuntimeRevisions in the requested page.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineRuntimeRevision" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse": { "description": "Response message for ReasoningEngineService.ListReasoningEngines", "id": "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse", @@ -57515,6 +61193,42 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ListSandboxEnvironmentSnapshotsResponse": { +"description": "Response message for SandboxEnvironmentService.ListSandboxEnvironmentSnapshots.", +"id": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentSnapshotsResponse", +"properties": { +"nextPageToken": { +"description": "A token, which can be sent as ListSandboxEnvironmentSnapshotsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", +"type": "string" +}, +"sandboxEnvironmentSnapshots": { +"description": "The SandboxEnvironmentSnapshots matching the request.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSnapshot" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1ListSandboxEnvironmentTemplatesResponse": { +"description": "Response message for SandboxEnvironmentService.ListSandboxEnvironmentTemplates.", +"id": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentTemplatesResponse", +"properties": { +"nextPageToken": { +"description": "A token, which can be sent as ListSandboxEnvironmentTemplatesRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", +"type": "string" +}, +"sandboxEnvironmentTemplates": { +"description": "The SandboxEnvironmentTemplates matching the request.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplate" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentsResponse": { "description": "Response message for SandboxEnvironmentService.ListSandboxEnvironments.", "id": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentsResponse", @@ -58111,45 +61825,59 @@ false "id": "GoogleCloudAiplatformV1beta1Memory", "properties": { "createTime": { -"description": "Output only. Timestamp when this Memory was created.", +"description": "Output only. Represents the timestamp when this Memory was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "description": { -"description": "Optional. Description of the Memory.", +"description": "Optional. Represents the description of the Memory.", "type": "string" }, "disableMemoryRevisions": { -"description": "Optional. Input only. If true, no revision will be created for this request.", +"description": "Optional. Input only. Indicates whether no revision will be created for this request.", "type": "boolean" }, "displayName": { -"description": "Optional. Display name of the Memory.", +"description": "Optional. Represents the display name of the Memory.", "type": "string" }, "expireTime": { -"description": "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.", +"description": "Optional. Represents the 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.", "format": "google-datetime", "type": "string" }, "fact": { -"description": "Optional. Semantic knowledge extracted from the source content.", +"description": "Optional. Represents semantic knowledge extracted from the source content.", +"type": "string" +}, +"memoryType": { +"description": "Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided.", +"enum": [ +"MEMORY_TYPE_UNSPECIFIED", +"NATURAL_LANGUAGE_COLLECTION", +"STRUCTURED_PROFILE" +], +"enumDescriptions": [ +"Represents an unspecified memory type. This value should not be used.", +"Indicates belonging to a collection of natural language memories.", +"Indicates belonging to a structured profile." +], "type": "string" }, "metadata": { "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1MemoryMetadataValue" }, -"description": "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.", +"description": "Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.", "type": "object" }, "name": { -"description": "Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", +"description": "Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "type": "string" }, "revisionExpireTime": { -"description": "Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.", +"description": "Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.", "format": "google-datetime", "type": "string" }, @@ -58157,11 +61885,11 @@ false "additionalProperties": { "type": "string" }, -"description": "Optional. Input only. The labels to apply to the Memory Revision created as a result of this request.", +"description": "Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.", "type": "object" }, "revisionTtl": { -"description": "Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL.", +"description": "Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.", "format": "google-duration", "type": "string" }, @@ -58169,23 +61897,27 @@ false "additionalProperties": { "type": "string" }, -"description": "Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.", +"description": "Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.", "type": "object" }, +"structuredContent": { +"$ref": "GoogleCloudAiplatformV1beta1MemoryStructuredContent", +"description": "Optional. Represents the structured content of the memory." +}, "topics": { -"description": "Optional. The Topics of the Memory.", +"description": "Optional. Represents the Topics of the Memory.", "items": { "$ref": "GoogleCloudAiplatformV1beta1MemoryTopicId" }, "type": "array" }, "ttl": { -"description": "Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.", +"description": "Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.", "format": "google-duration", "type": "string" }, "updateTime": { -"description": "Output only. Timestamp when this Memory was most recently updated.", +"description": "Output only. Represents the timestamp when this Memory was most recently updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -58194,33 +61926,37 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfig": { -"description": "Represents configuration for organizing memories for a particular scope.", +"description": "Represents configuration for organizing natural language memories for a particular scope.", "id": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfig", "properties": { "consolidationConfig": { "$ref": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigConsolidationConfig", "description": "Optional. Represents configuration for customizing how memories are consolidated together." }, +"disableNaturalLanguageMemories": { +"description": "Optional. Indicates whether natural language memory generation should be disabled for all requests. By default, natural language memory generation is enabled. Set this to `true` when you only want to generate structured memories.", +"type": "boolean" +}, "enableThirdPersonMemories": { -"description": "Optional. If true, then the memories will be generated in the third person (i.e. \"The user generates memories with Memory Bank.\"). By default, the memories will be generated in the first person (i.e. \"I generate memories with Memory Bank.\")", +"description": "Optional. Indicates whether the memories will be generated in the third person (i.e. \"The user generates memories with Memory Bank.\"). By default, the memories will be generated in the first person (i.e. \"I generate memories with Memory Bank.\")", "type": "boolean" }, "generateMemoriesExamples": { -"description": "Optional. Examples of how to generate memories for a particular scope.", +"description": "Optional. Provides examples of how to generate memories for a particular scope.", "items": { "$ref": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExample" }, "type": "array" }, "memoryTopics": { -"description": "Optional. Topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used.", +"description": "Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used.", "items": { "$ref": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigMemoryTopic" }, "type": "array" }, "scopeKeys": { -"description": "Optional. The scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank.", +"description": "Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank.", "items": { "type": "string" }, @@ -58234,7 +61970,7 @@ false "id": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigConsolidationConfig", "properties": { "revisionsPerCandidateCount": { -"description": "Optional. The maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered.", +"description": "Optional. Represents the maximum number of revisions to consider for each candidate memory. If not set, then the default value (1) will be used, which means that only the latest revision will be considered.", "format": "int32", "type": "integer" } @@ -58250,7 +61986,7 @@ false "description": "A conversation source for the example." }, "generatedMemories": { -"description": "Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation.", +"description": "Optional. Represents the memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation.", "items": { "$ref": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleGeneratedMemory" }, @@ -58264,7 +62000,7 @@ false "id": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSource", "properties": { "events": { -"description": "Optional. The input conversation events for the example.", +"description": "Optional. Represents the input conversation events for the example.", "items": { "$ref": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceEvent" }, @@ -58279,7 +62015,7 @@ false "properties": { "content": { "$ref": "GoogleCloudAiplatformV1beta1Content", -"description": "Required. The content of the event." +"description": "Required. Represents the content of the event." } }, "type": "object" @@ -58289,11 +62025,11 @@ false "id": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleGeneratedMemory", "properties": { "fact": { -"description": "Required. The fact to generate a memory from.", +"description": "Required. Represents the fact to generate a memory from.", "type": "string" }, "topics": { -"description": "Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = \"jargon\"` if the extracted memory is an example of memory extraction for the custom topic `jargon`.", +"description": "Optional. Represents the list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = \"jargon\"` if the extracted memory is an example of memory extraction for the custom topic `jargon`.", "items": { "$ref": "GoogleCloudAiplatformV1beta1MemoryTopicId" }, @@ -58322,11 +62058,11 @@ false "id": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigMemoryTopicCustomMemoryTopic", "properties": { "description": { -"description": "Required. Description of the memory topic. This should explain what information should be extracted for this topic.", +"description": "Required. Represents the description of the memory topic. This should explain what information should be extracted for this topic.", "type": "string" }, "label": { -"description": "Required. The label of the topic.", +"description": "Required. Represents the label of the topic.", "type": "string" } }, @@ -58337,7 +62073,7 @@ false "id": "GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigMemoryTopicManagedMemoryTopic", "properties": { "managedTopicEnum": { -"description": "Required. The managed topic.", +"description": "Required. Represents the managed topic.", "enum": [ "MANAGED_TOPIC_ENUM_UNSPECIFIED", "USER_PERSONAL_INFO", @@ -58346,11 +62082,11 @@ false "EXPLICIT_INSTRUCTIONS" ], "enumDescriptions": [ -"Unspecified topic. This value should not be used.", -"Significant personal information about the User like first names, relationships, hobbies, important dates.", -"Stated or implied likes, dislikes, preferred styles, or patterns.", -"Important milestones or conclusions within the dialogue.", -"Information that the user explicitly requested to remember or forget." +"Represents an unspecified topic. This value should not be used.", +"Represents significant personal information about the User like first names, relationships, hobbies, important dates.", +"Represents stated or implied likes, dislikes, preferred styles, or patterns.", +"Represents important milestones or conclusions within the dialogue.", +"Represents information that the user explicitly requested to remember or forget." ], "type": "string" } @@ -58362,7 +62098,7 @@ false "id": "GoogleCloudAiplatformV1beta1MemoryConjunctionFilter", "properties": { "filters": { -"description": "Filters that will combined using AND logic.", +"description": "Represents filters that will be combined using AND logic.", "items": { "$ref": "GoogleCloudAiplatformV1beta1MemoryFilter" }, @@ -58376,15 +62112,15 @@ false "id": "GoogleCloudAiplatformV1beta1MemoryFilter", "properties": { "key": { -"description": "Key of the filter. For example, \"author\" would apply to `metadata` entries with the key \"author\".", +"description": "Represents the key of the filter. For example, \"author\" would apply to `metadata` entries with the key \"author\".", "type": "string" }, "negate": { -"description": "If true, the filter will be negated.", +"description": "Indicates whether the filter will be negated.", "type": "boolean" }, "op": { -"description": "Operator to apply to the filter. If not set, then EQUAL will be used.", +"description": "Represents the operator to apply to the filter. If not set, then EQUAL will be used.", "enum": [ "OPERATOR_UNSPECIFIED", "EQUAL", @@ -58392,7 +62128,7 @@ false "LESS_THAN" ], "enumDescriptions": [ -"Unspecified operator. Defaults to EQUAL.", +"Represents an unspecified operator. Defaults to EQUAL.", "Equal to.", "Greater than.", "Less than." @@ -58401,7 +62137,40 @@ false }, "value": { "$ref": "GoogleCloudAiplatformV1beta1MemoryMetadataValue", -"description": "Value to compare to." +"description": "Represents the value to compare to." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfig": { +"description": "Represents configuration for triggering generation.", +"id": "GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfig", +"properties": { +"generationRule": { +"$ref": "GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfigGenerationTriggerRule", +"description": "Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfigGenerationTriggerRule": { +"description": "Represents the active rule that determines when to flush the buffer.", +"id": "GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfigGenerationTriggerRule", +"properties": { +"eventCount": { +"description": "Optional. Specifies to trigger generation when the event count reaches this limit.", +"format": "int32", +"type": "integer" +}, +"fixedInterval": { +"description": "Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity.", +"format": "google-duration", +"type": "string" +}, +"idleDuration": { +"description": "Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity.", +"format": "google-duration", +"type": "string" } }, "type": "object" @@ -58411,44 +62180,63 @@ false "id": "GoogleCloudAiplatformV1beta1MemoryMetadataValue", "properties": { "boolValue": { -"description": "Boolean value.", +"description": "Represents a boolean value.", "type": "boolean" }, "doubleValue": { -"description": "Double value.", +"description": "Represents a double value.", "format": "double", "type": "number" }, "stringValue": { -"description": "String value.", +"description": "Represents a string value.", "type": "string" }, "timestampValue": { -"description": "Timestamp value. When filtering on timestamp values, only the seconds field will be compared.", +"description": "Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.", "format": "google-datetime", "type": "string" } }, "type": "object" }, +"GoogleCloudAiplatformV1beta1MemoryProfile": { +"description": "A memory profile.", +"id": "GoogleCloudAiplatformV1beta1MemoryProfile", +"properties": { +"profile": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Represents the profile data.", +"type": "object" +}, +"schemaId": { +"description": "Represents the ID of the schema. This ID corresponds to the `schema_id` defined inside the SchemaConfig, under StructuredMemoryCustomizationConfig.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1MemoryRevision": { "description": "A revision of a Memory.", "id": "GoogleCloudAiplatformV1beta1MemoryRevision", "properties": { "createTime": { -"description": "Output only. Timestamp when this Memory Revision was created.", +"description": "Output only. Represents the timestamp when this Memory Revision was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "expireTime": { -"description": "Output only. Timestamp of when this resource is considered expired.", +"description": "Output only. Represents the timestamp of when this resource is considered expired.", "format": "google-datetime", "readOnly": true, "type": "string" }, "extractedMemories": { -"description": "Output only. The extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation.", +"description": "Output only. Represents the extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation.", "items": { "$ref": "GoogleCloudAiplatformV1beta1IntermediateExtractedMemory" }, @@ -58456,7 +62244,7 @@ false "type": "array" }, "fact": { -"description": "Output only. The fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation.", +"description": "Output only. Represents the fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation.", "readOnly": true, "type": "string" }, @@ -58464,12 +62252,40 @@ false "additionalProperties": { "type": "string" }, -"description": "Output only. The labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`.", +"description": "Output only. Represents the labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`.", "readOnly": true, "type": "object" }, "name": { -"description": "Identifier. The resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}`", +"description": "Identifier. Represents the resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}`", +"type": "string" +}, +"structuredData": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Output only. Represents the structured value of the memory at the time of revision creation.", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1MemoryStructuredContent": { +"description": "Represents the structured value of the memory.", +"id": "GoogleCloudAiplatformV1beta1MemoryStructuredContent", +"properties": { +"data": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Required. Represents the structured value of the memory.", +"type": "object" +}, +"schemaId": { +"description": "Required. Represents the schema ID for which this structured memory belongs to.", "type": "string" } }, @@ -58480,11 +62296,11 @@ false "id": "GoogleCloudAiplatformV1beta1MemoryTopicId", "properties": { "customMemoryTopicLabel": { -"description": "Optional. The custom memory topic label.", +"description": "Optional. Represents the custom memory topic label.", "type": "string" }, "managedMemoryTopic": { -"description": "Optional. The managed memory topic.", +"description": "Optional. Represents the managed memory topic.", "enum": [ "MANAGED_TOPIC_ENUM_UNSPECIFIED", "USER_PERSONAL_INFO", @@ -58493,11 +62309,11 @@ false "EXPLICIT_INSTRUCTIONS" ], "enumDescriptions": [ -"Unspecified topic. This value should not be used.", -"Significant personal information about the User like first names, relationships, hobbies, important dates.", -"Stated or implied likes, dislikes, preferred styles, or patterns.", -"Important milestones or conclusions within the dialogue.", -"Information that the user explicitly requested to remember or forget." +"Represents an unspecified topic. This value should not be used.", +"Represents significant personal information about the User like first names, relationships, hobbies, important dates.", +"Represents stated or implied likes, dislikes, preferred styles, or patterns.", +"Represents important milestones or conclusions within the dialogue.", +"Represents information that the user explicitly requested to remember or forget." ], "type": "string" } @@ -62598,7 +66414,7 @@ false "type": "string" }, "metricSources": { -"description": "Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided.", +"description": "Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided. Right now, only predefined metrics and registered metrics are supported. Every registered metric must have `display_name` (or `title`) and `score_range` defined. Otherwise, the evaluations will fail. The maximum number of `metric_sources` is 25.", "items": { "$ref": "GoogleCloudAiplatformV1beta1MetricSource" }, @@ -62618,13 +66434,21 @@ false ], "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." +"Indicates that the OnlineEvaluator is active.", +"Indicates that the OnlineEvaluator is suspended. In this state, the OnlineEvaluator will not evaluate any samples.", +"Indicates that the OnlineEvaluator is in a failed state. This can happen if, for example, the `log_view` or `trace_view` set on the `CloudObservability` does not exist." ], "readOnly": true, "type": "string" }, +"stateDetails": { +"description": "Output only. Contains additional information about the state of the OnlineEvaluator. This is used to provide more details in the event of a failure.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorStateDetails" +}, +"readOnly": true, +"type": "array" +}, "updateTime": { "description": "Output only. Timestamp when the OnlineEvaluator was last updated.", "format": "google-datetime", @@ -62703,11 +66527,11 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityTraceScope": { -"description": "Defines the scope and filters for selecting traces.", +"description": "If chosen, the online evaluator will evaluate single traces matching specified `filter`.", "id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityTraceScope", "properties": { "filter": { -"description": "Optional. A list of predicates to filter traces. Multiple predicates are combined using AND.", +"description": "Optional. A list of predicates to filter traces. Multiple predicates are combined using AND. The maximum number of predicates is 10.", "items": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityTraceScopePredicate" }, @@ -62752,13 +66576,25 @@ false "id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorConfigRandomSampling", "properties": { "percentage": { -"description": "Required. The percentage of traces to sample for evaluation. Must be an integer between 0 and 100.", +"description": "Required. The percentage of traces to sample for evaluation. Must be an integer between `1` and `100`.", "format": "int32", "type": "integer" } }, "type": "object" }, +"GoogleCloudAiplatformV1beta1OnlineEvaluatorStateDetails": { +"description": "Contains additional information about the state of the OnlineEvaluator.", +"id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorStateDetails", +"properties": { +"message": { +"description": "Output only. Human-readable message describing the state of the OnlineEvaluator.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1OptimizePromptRequest": { "description": "Request message for GenAiTuningService.OptimizePrompt.", "id": "GoogleCloudAiplatformV1beta1OptimizePromptRequest", @@ -65838,6 +69674,14 @@ false "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." @@ -67190,6 +71034,10 @@ false "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpec", "description": "Optional. Configurations of the ReasoningEngine" }, +"trafficConfig": { +"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfig", +"description": "Optional. Traffic distribution configuration for the Reasoning Engine." +}, "updateTime": { "description": "Output only. Timestamp when this ReasoningEngine was most recently updated.", "format": "google-datetime", @@ -67233,6 +71081,13 @@ false "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigSimilaritySearchConfig", "description": "Optional. Configuration for how to perform similarity search on memories. If not set, the Memory Bank will use the default embedding model `text-embedding-005`." }, +"structuredMemoryConfigs": { +"description": "Optional. Configuration for organizing structured memories for a particular scope.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1StructuredMemoryConfig" +}, +"type": "array" +}, "ttlConfig": { "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigTtlConfig", "description": "Optional. Configuration for automatic TTL (\"time-to-live\") of the memories in the Memory Bank. If not set, TTL will not be applied automatically. The TTL can be explicitly set by modifying the `expire_time` of each Memory resource." @@ -67244,8 +71099,12 @@ false "description": "Configuration for how to generate memories.", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigGenerationConfig", "properties": { +"generationTriggerConfig": { +"$ref": "GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfig", +"description": "Optional. Specifies the default trigger configuration for generating memories using `IngestEvents`." +}, "model": { -"description": "Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`.", +"description": "Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`.", "type": "string" } }, @@ -67305,6 +71164,42 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ReasoningEngineRuntimeRevision": { +"description": "ReasoningEngineRuntimeRevision is a specific version of the runtime related part of ReasoningEngine. Contains only the fields that are revision specific.", +"id": "GoogleCloudAiplatformV1beta1ReasoningEngineRuntimeRevision", +"properties": { +"createTime": { +"description": "Output only. Timestamp when this ReasoningEngineRuntimeRevision was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the ReasoningEngineRuntimeRevision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/runtimeRevisions/{runtime_revision}`", +"type": "string" +}, +"spec": { +"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpec", +"description": "Immutable. Configurations of the ReasoningEngineRuntimeRevision. Contains only revision specific fields." +}, +"state": { +"description": "Output only. The state of the revision.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"DEPRECATED" +], +"enumDescriptions": [ +"The unspecified state.", +"Is deployed and ready to be used.", +"Is deprecated, may not be used, only preserved for historical purposes." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ReasoningEngineSpec": { "description": "ReasoningEngine configurations", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpec", @@ -67389,6 +71284,10 @@ false "description": "The specification of a Reasoning Engine deployment.", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec", "properties": { +"agentGatewayConfig": { +"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpecAgentGatewayConfig", +"description": "Optional. Agent Gateway configuration for the Reasoning Engine deployment." +}, "agentServerMode": { "description": "The agent server mode.", "enum": [ @@ -67450,6 +71349,43 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpecAgentGatewayConfig": { +"description": "Agent Gateway configuration for a Reasoning Engine deployment.", +"id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpecAgentGatewayConfig", +"properties": { +"agentToAnywhereConfig": { +"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfig", +"description": "Optional. Configuration for traffic originating from the Reasoning Engine. When unset, outgoing traffic is not routed through an Agent Gateway." +}, +"clientToAgentConfig": { +"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfig", +"description": "Optional. Configuration for traffic targeting the Reasoning Engine. When unset, incoming traffic is not routed through an Agent Gateway." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfig": { +"description": "Configuration for traffic originating from a Reasoning Engine.", +"id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfig", +"properties": { +"agentGateway": { +"description": "Required. The resource name of the Agent Gateway for outbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `AGENT_TO_ANYWHERE`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfig": { +"description": "Configuration for traffic targeting a Reasoning Engine.", +"id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfig", +"properties": { +"agentGateway": { +"description": "Required. The resource name of the Agent Gateway to use for inbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `CLIENT_TO_AGENT`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}`", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec": { "description": "User-provided package specification, containing pickled object and package requirements.", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec", @@ -67609,6 +71545,57 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfig": { +"description": "Traffic distribution configuration.", +"id": "GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfig", +"properties": { +"trafficSplitAlwaysLatest": { +"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfigTrafficSplitAlwaysLatest", +"description": "Optional. Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision." +}, +"trafficSplitManual": { +"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfigTrafficSplitManual", +"description": "Optional. Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfigTrafficSplitAlwaysLatest": { +"description": "Traffic distribution configuration, where all traffic is sent to the latest Runtime Revision.", +"id": "GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfigTrafficSplitAlwaysLatest", +"properties": {}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfigTrafficSplitManual": { +"description": "Manual traffic distribution configuration, where the user specifies the Runtime Revision IDs and the percentage of traffic to send to each.", +"id": "GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfigTrafficSplitManual", +"properties": { +"targets": { +"description": "A list of traffic targets for the Runtimes Revisions. The sum of percentages must equal to 100.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfigTrafficSplitManualTarget" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfigTrafficSplitManualTarget": { +"description": "A single target for the traffic split, specifying a Runtime Revision and the percentage of traffic to send to it.", +"id": "GoogleCloudAiplatformV1beta1ReasoningEngineTrafficConfigTrafficSplitManualTarget", +"properties": { +"percent": { +"description": "Required. Specifies percent of the traffic to this Runtime Revision.", +"format": "int32", +"type": "integer" +}, +"runtimeRevisionName": { +"description": "Required. The Runtime Revision name to which to send this portion of traffic, if traffic allocation is by Runtime Revision.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1RebaseTunedModelRequest": { "description": "Request message for GenAiTuningService.RebaseTunedModel.", "id": "GoogleCloudAiplatformV1beta1RebaseTunedModelRequest", @@ -68231,6 +72218,23 @@ false }, "type": "array" }, +"memoryTypes": { +"description": "Optional. Specifies the types of memories to retrieve. If this field is empty or not provided, the request will default to retrieving only memories of type `NATURAL_LANGUAGE_COLLECTION`. If populated, the request will retrieve memories matching any of the specified `MemoryType` values.", +"items": { +"enum": [ +"MEMORY_TYPE_UNSPECIFIED", +"NATURAL_LANGUAGE_COLLECTION", +"STRUCTURED_PROFILE" +], +"enumDescriptions": [ +"Represents an unspecified memory type. This value should not be used.", +"Indicates belonging to a collection of natural language memories.", +"Indicates belonging to a structured profile." +], +"type": "string" +}, +"type": "array" +}, "scope": { "additionalProperties": { "type": "string" @@ -68315,6 +72319,34 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1RetrieveProfilesRequest": { +"description": "Request message for MemoryBankService.RetrieveProfiles.", +"id": "GoogleCloudAiplatformV1beta1RetrieveProfilesRequest", +"properties": { +"scope": { +"additionalProperties": { +"type": "string" +}, +"description": "Required. The scope of the profiles to retrieve.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1RetrieveProfilesResponse": { +"description": "Response message for MemoryBankService.RetrieveProfiles.", +"id": "GoogleCloudAiplatformV1beta1RetrieveProfilesResponse", +"properties": { +"profiles": { +"additionalProperties": { +"$ref": "GoogleCloudAiplatformV1beta1MemoryProfile" +}, +"description": "The retrieved structured profiles, which match the schemas under the requested scope. The key is the ID of the schema that the profile is linked with, which corresponds to the `schema_id` defined inside the `SchemaConfig`, under `StructuredMemoryCustomizationConfig`.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1RollbackMemoryRequest": { "description": "Request message for MemoryBankService.RollbackMemory.", "id": "GoogleCloudAiplatformV1beta1RollbackMemoryRequest", @@ -69162,6 +73194,11 @@ false "readOnly": true, "type": "string" }, +"sandboxHostname": { +"description": "Output only. The hostname of the SandboxEnvironment.", +"readOnly": true, +"type": "string" +}, "sandboxInternalIp": { "description": "Output only. The internal IP address of the SandboxEnvironment.", "readOnly": true, @@ -69170,6 +73207,76 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1SandboxEnvironmentSnapshot": { +"description": "SandboxEnvironmentSnapshot is a snapshot of the SandboxEnvironment.", +"id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSnapshot", +"properties": { +"createTime": { +"description": "Output only. The timestamp when this SandboxEnvironmentSnapshot was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Required. The display name of the SandboxEnvironmentSnapshot.", +"type": "string" +}, +"expireTime": { +"description": "Optional. Timestamp in UTC of when this SandboxEnvironmentSnapshot is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.", +"format": "google-datetime", +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the SandboxEnvironmentSnapshot. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot}`", +"type": "string" +}, +"owner": { +"description": "Optional. Owner information for this sandbox snapshot. Different owners will have isolations on snapshot storage and identity. If not set, snapshot will be created as the default owner.", +"type": "string" +}, +"parentSnapshot": { +"description": "Output only. The resource name of the parent SandboxEnvironmentSnapshot. Empty if this is a root Snapshot (the first snapshot from a newly created sandbox). Can be used to reconstruct the whole ancestry tree of snapshots.", +"readOnly": true, +"type": "string" +}, +"postSnapshotAction": { +"description": "Optional. Input only. Action to take on the source SandboxEnvironment after the snapshot is taken. This field is only used in CreateSandboxEnvironmentSnapshotRequest and it is not stored in the resource.", +"enum": [ +"POST_SNAPSHOT_ACTION_UNSPECIFIED", +"RUNNING", +"PAUSE" +], +"enumDescriptions": [ +"The default value. This value is unused.", +"Sandbox environment will continue to run after snapshot is taken.", +"Sandbox environment will be paused after snapshot is taken." +], +"type": "string" +}, +"sizeBytes": { +"description": "Optional. Output only. Size of the snapshot data in bytes.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"sourceSandboxEnvironment": { +"description": "Required. The resource name of the source SandboxEnvironment this snapshot was taken from.", +"type": "string" +}, +"ttl": { +"description": "Optional. Input only. The TTL for the sandbox environment snapshot. The expiration time is computed: now + TTL.", +"format": "google-duration", +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when this SandboxEnvironment was most recently updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1SandboxEnvironmentSpec": { "description": "The specification of a SandboxEnvironment.", "id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentSpec", @@ -69224,6 +73331,177 @@ false "properties": {}, "type": "object" }, +"GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplate": { +"description": "The specification of a SandboxEnvironmentTemplate. A SandboxEnvironmentTemplate defines a template for creating SandboxEnvironments.", +"id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplate", +"properties": { +"createTime": { +"description": "Output only. The timestamp when this SandboxEnvironmentTemplate was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"customContainerEnvironment": { +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateCustomContainerEnvironment", +"description": "The sandbox environment for custom container workloads." +}, +"defaultContainerEnvironment": { +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateDefaultContainerEnvironment", +"description": "The sandbox environment for default container workloads." +}, +"displayName": { +"description": "Required. The display name of the SandboxEnvironmentTemplate.", +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`", +"type": "string" +}, +"state": { +"description": "Output only. The state of the sandbox environment template.", +"enum": [ +"UNSPECIFIED", +"PROVISIONING", +"ACTIVE", +"DEPROVISIONING", +"DELETED", +"FAILED" +], +"enumDescriptions": [ +"The default value. This value is unused.", +"Runtime resources are being allocated for the sandbox environment.", +"Sandbox runtime is ready for serving.", +"Sandbox runtime is halted, performing tear down tasks.", +"Sandbox has terminated with underlying runtime failure.", +"Sandbox has failed to provision." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when this SandboxEnvironmentTemplate was most recently updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"warmPoolConfig": { +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateWarmPoolConfig", +"description": "Optional. The configuration for the warm pool of this template." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateCustomContainerEnvironment": { +"description": "The customized sandbox runtime environment for BYOC.", +"id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateCustomContainerEnvironment", +"properties": { +"customContainerSpec": { +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateCustomContainerSpec", +"description": "The specification of the custom container environment." +}, +"ports": { +"description": "Ports to expose from the container.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateNetworkPort" +}, +"type": "array" +}, +"resources": { +"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateResourceRequirements", +"description": "Resource requests and limits for the container." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateCustomContainerSpec": { +"description": "Specification for deploying from a custom container image.", +"id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateCustomContainerSpec", +"properties": { +"imageUri": { +"description": "Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateDefaultContainerEnvironment": { +"description": "The default sandbox runtime environment for default container workloads.", +"id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateDefaultContainerEnvironment", +"properties": { +"defaultContainerCategory": { +"description": "Required. The category of the default container image.", +"enum": [ +"DEFAULT_CONTAINER_CATEGORY_UNSPECIFIED", +"DEFAULT_CONTAINER_CATEGORY_COMPUTER_USE" +], +"enumDescriptions": [ +"The default value. This value is unused.", +"The default container image for Computer Use." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateNetworkPort": { +"description": "Represents a network port in a container.", +"id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateNetworkPort", +"properties": { +"port": { +"description": "Optional. Port number to expose. This must be a valid port number, between 1 and 65535.", +"format": "int32", +"type": "integer" +}, +"protocol": { +"description": "Optional. Protocol for port. Defaults to TCP if not specified.", +"enum": [ +"PROTOCOL_UNSPECIFIED", +"TCP", +"UDP" +], +"enumDescriptions": [ +"Unspecified protocol. Defaults to TCP.", +"TCP protocol.", +"UDP protocol." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateResourceRequirements": { +"description": "Message to define resource requests and limits (mirroring Kubernetes) for each sandbox instance created from this template.", +"id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateResourceRequirements", +"properties": { +"limits": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The maximum amounts of compute resources allowed. Keys are resource names (e.g., \"cpu\", \"memory\"). Values are quantities (e.g., \"500m\", \"1Gi\").", +"type": "object" +}, +"requests": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The requested amounts of compute resources. Keys are resource names (e.g., \"cpu\", \"memory\"). Values are quantities (e.g., \"250m\", \"512Mi\").", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateWarmPoolConfig": { +"description": "Configuration for a warm pool of sandbox instances.", +"id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateWarmPoolConfig", +"properties": { +"targetInstanceCount": { +"description": "Optional. The target number of pre-warmed instances to maintain.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1SavedQuery": { "description": "A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.", "id": "GoogleCloudAiplatformV1beta1SavedQuery", @@ -74989,6 +79267,56 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1StructuredMemoryConfig": { +"description": "Represents configuration for organizing structured memories for a particular scope.", +"id": "GoogleCloudAiplatformV1beta1StructuredMemoryConfig", +"properties": { +"schemaConfigs": { +"description": "Optional. Represents configuration of the structured memories' schemas.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1StructuredMemoryConfigSchemaConfig" +}, +"type": "array" +}, +"scopeKeys": { +"description": "Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1StructuredMemoryConfigSchemaConfig": { +"description": "Schema configuration for structured memories.", +"id": "GoogleCloudAiplatformV1beta1StructuredMemoryConfigSchemaConfig", +"properties": { +"id": { +"description": "Required. Represents the ID of the schema. Must be 1-63 characters, start with a lowercase letter, and consist of lowercase letters, numbers, and hyphens.", +"type": "string" +}, +"memoryType": { +"description": "Optional. Represents the type of the structured memories associated with the schema. If not set, then `STRUCTURED_PROFILE` will be used.", +"enum": [ +"MEMORY_TYPE_UNSPECIFIED", +"NATURAL_LANGUAGE_COLLECTION", +"STRUCTURED_PROFILE" +], +"enumDescriptions": [ +"Represents an unspecified memory type. This value should not be used.", +"Indicates belonging to a collection of natural language memories.", +"Indicates belonging to a structured profile." +], +"type": "string" +}, +"schema": { +"$ref": "GoogleCloudAiplatformV1beta1Schema", +"description": "Required. Represents the OpenAPI schema of the structured memories. The schema `type` cannot be `ARRAY` when `memory_type` is `STRUCTURED_PROFILE`." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1Study": { "description": "A message representing a Study.", "id": "GoogleCloudAiplatformV1beta1Study", @@ -76130,6 +80458,17 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1SuspendOnlineEvaluatorOperationMetadata": { +"description": "Metadata for the SuspendOnlineEvaluator operation.", +"id": "GoogleCloudAiplatformV1beta1SuspendOnlineEvaluatorOperationMetadata", +"properties": { +"genericMetadata": { +"$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", +"description": "Common part of operation metadata." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1SuspendOnlineEvaluatorRequest": { "description": "Request message for SuspendOnlineEvaluator.", "id": "GoogleCloudAiplatformV1beta1SuspendOnlineEvaluatorRequest", @@ -78771,6 +83110,17 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1UpdateOnlineEvaluatorOperationMetadata": { +"description": "Metadata for the UpdateOnlineEvaluator operation.", +"id": "GoogleCloudAiplatformV1beta1UpdateOnlineEvaluatorOperationMetadata", +"properties": { +"genericMetadata": { +"$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", +"description": "Generic operation metadata." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1UpdatePersistentResourceOperationMetadata": { "description": "Details of operations that perform update PersistentResource.", "id": "GoogleCloudAiplatformV1beta1UpdatePersistentResourceOperationMetadata", From 195a5c64db614c4944a6236fb789e543377a909f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:40:58 +0000 Subject: [PATCH 04/32] feat(analyticsadmin): update the api #### analyticsadmin:v1alpha The following keys were added: - resources.properties.methods.getUserProvidedDataSettings (Total Keys: 11) - schemas.GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource.properties.userProvidedDataSettings.$ref (Total Keys: 1) - schemas.GoogleAnalyticsAdminV1alphaUserProvidedDataSettings (Total Keys: 5) --- docs/dyn/analyticsadmin_v1alpha.accounts.html | 10 ++++ .../analyticsadmin_v1alpha.properties.html | 24 ++++++++ .../documents/analyticsadmin.v1alpha.json | 57 ++++++++++++++++++- 3 files changed, 88 insertions(+), 3 deletions(-) diff --git a/docs/dyn/analyticsadmin_v1alpha.accounts.html b/docs/dyn/analyticsadmin_v1alpha.accounts.html index d1842896a6..efeac11418 100644 --- a/docs/dyn/analyticsadmin_v1alpha.accounts.html +++ b/docs/dyn/analyticsadmin_v1alpha.accounts.html @@ -1068,6 +1068,11 @@

Method Details

"customDimensionAndMetricSyncMode": "A String", # Required. Specifies the Custom Dimension / Metric synchronization mode for the subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty. "name": "A String", # Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678 }, + "userProvidedDataSettings": { # Configuration for user-provided data collection. This is a singleton resource for a Google Analytics property. # A snapshot of a UserProvidedDataSettings resource in change history. + "automaticallyDetectedDataCollectionEnabled": True or False, # Optional. Whether this property allows a Google Tag to automatically collect user-provided data from your website. This setting only takes effect if `user_provided_data_collection_enabled` is also true. + "name": "A String", # Identifier. Resource name of this setting. Format: properties/{property}/userProvidedDataSettings Example: "properties/1000/userProvidedDataSettings" + "userProvidedDataCollectionEnabled": True or False, # Optional. Whether this property accepts user-provided data sent to it. + }, }, "resourceBeforeChange": { # A snapshot of a resource as before or after the result of a change in change history. # Resource contents from before the change was made. If this resource was created in this change, this field will be missing. "account": { # A resource message representing a Google Analytics account. # A snapshot of an Account resource in change history. @@ -1597,6 +1602,11 @@

Method Details

"customDimensionAndMetricSyncMode": "A String", # Required. Specifies the Custom Dimension / Metric synchronization mode for the subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty. "name": "A String", # Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678 }, + "userProvidedDataSettings": { # Configuration for user-provided data collection. This is a singleton resource for a Google Analytics property. # A snapshot of a UserProvidedDataSettings resource in change history. + "automaticallyDetectedDataCollectionEnabled": True or False, # Optional. Whether this property allows a Google Tag to automatically collect user-provided data from your website. This setting only takes effect if `user_provided_data_collection_enabled` is also true. + "name": "A String", # Identifier. Resource name of this setting. Format: properties/{property}/userProvidedDataSettings Example: "properties/1000/userProvidedDataSettings" + "userProvidedDataCollectionEnabled": True or False, # Optional. Whether this property accepts user-provided data sent to it. + }, }, }, ], diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.html b/docs/dyn/analyticsadmin_v1alpha.properties.html index b7cdfc2b43..96752436e5 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.html @@ -209,6 +209,9 @@

Instance Methods

getReportingIdentitySettings(name, x__xgafv=None)

Returns the reporting identity settings for this property.

+

+ getUserProvidedDataSettings(name, x__xgafv=None)

+

Looks up settings related to user-provided data for a property.

list(filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)

Returns child Properties under the specified parent Account. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.

@@ -526,6 +529,27 @@

Method Details

} +
+ getUserProvidedDataSettings(name, x__xgafv=None) +
Looks up settings related to user-provided data for a property.
+
+Args:
+  name: string, Required. The name of the user provided data settings to retrieve. Format: properties/{property}/userProvidedDataSettings (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Configuration for user-provided data collection. This is a singleton resource for a Google Analytics property.
+  "automaticallyDetectedDataCollectionEnabled": True or False, # Optional. Whether this property allows a Google Tag to automatically collect user-provided data from your website. This setting only takes effect if `user_provided_data_collection_enabled` is also true.
+  "name": "A String", # Identifier. Resource name of this setting. Format: properties/{property}/userProvidedDataSettings Example: "properties/1000/userProvidedDataSettings"
+  "userProvidedDataCollectionEnabled": True or False, # Optional. Whether this property accepts user-provided data sent to it.
+}
+
+
list(filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)
Returns child Properties under the specified parent Account. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.
diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json
index 043264a604..770f95431e 100644
--- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json
@@ -856,6 +856,32 @@
 "https://www.googleapis.com/auth/analytics.readonly"
 ]
 },
+"getUserProvidedDataSettings": {
+"description": "Looks up settings related to user-provided data for a property.",
+"flatPath": "v1alpha/properties/{propertiesId}/userProvidedDataSettings",
+"httpMethod": "GET",
+"id": "analyticsadmin.properties.getUserProvidedDataSettings",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the user provided data settings to retrieve. Format: properties/{property}/userProvidedDataSettings",
+"location": "path",
+"pattern": "^properties/[^/]+/userProvidedDataSettings$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+name}",
+"response": {
+"$ref": "GoogleAnalyticsAdminV1alphaUserProvidedDataSettings"
+},
+"scopes": [
+"https://www.googleapis.com/auth/analytics.edit",
+"https://www.googleapis.com/auth/analytics.readonly"
+]
+},
 "list": {
 "description": "Returns child Properties under the specified parent Account. Properties will be excluded if the caller does not have access. Soft-deleted (ie: \"trashed\") properties are excluded by default. Returns an empty list if no relevant properties are found.",
 "flatPath": "v1alpha/properties",
@@ -5086,7 +5112,7 @@
 }
 }
 },
-"revision": "20260331",
+"revision": "20260412",
 "rootUrl": "https://analyticsadmin.googleapis.com/",
 "schemas": {
 "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": {
@@ -6487,6 +6513,10 @@
 "subpropertySyncConfig": {
 "$ref": "GoogleAnalyticsAdminV1alphaSubpropertySyncConfig",
 "description": "A snapshot of a SubpropertySyncConfig resource in change history."
+},
+"userProvidedDataSettings": {
+"$ref": "GoogleAnalyticsAdminV1alphaUserProvidedDataSettings",
+"description": "A snapshot of a UserProvidedDataSettings resource in change history."
 }
 },
 "type": "object"
@@ -9079,7 +9109,8 @@
 "CALCULATED_METRIC",
 "REPORTING_DATA_ANNOTATION",
 "SUBPROPERTY_SYNC_CONFIG",
-"REPORTING_IDENTITY_SETTINGS"
+"REPORTING_IDENTITY_SETTINGS",
+"USER_PROVIDED_DATA_SETTINGS"
 ],
 "enumDescriptions": [
 "Resource type unknown or not specified.",
@@ -9111,7 +9142,8 @@
 "CalculatedMetric resource",
 "ReportingDataAnnotation resource",
 "SubpropertySyncConfig resource",
-"ReportingIdentitySettings resource"
+"ReportingIdentitySettings resource",
+"UserProvidedDataSettings resource"
 ],
 "type": "string"
 },
@@ -9352,6 +9384,25 @@
 },
 "type": "object"
 },
+"GoogleAnalyticsAdminV1alphaUserProvidedDataSettings": {
+"description": "Configuration for user-provided data collection. This is a singleton resource for a Google Analytics property.",
+"id": "GoogleAnalyticsAdminV1alphaUserProvidedDataSettings",
+"properties": {
+"automaticallyDetectedDataCollectionEnabled": {
+"description": "Optional. Whether this property allows a Google Tag to automatically collect user-provided data from your website. This setting only takes effect if `user_provided_data_collection_enabled` is also true.",
+"type": "boolean"
+},
+"name": {
+"description": "Identifier. Resource name of this setting. Format: properties/{property}/userProvidedDataSettings Example: \"properties/1000/userProvidedDataSettings\"",
+"type": "string"
+},
+"userProvidedDataCollectionEnabled": {
+"description": "Optional. Whether this property accepts user-provided data sent to it.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "GoogleProtobufEmpty": {
 "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
 "id": "GoogleProtobufEmpty",

From 273470c280aebd2126451e17f7ceb10785e4cea0 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 14 Apr 2026 07:40:58 +0000
Subject: [PATCH 05/32] feat(ces): update the api

#### ces:v1

The following keys were added:
- schemas.AgentTool.properties.agent.type (Total Keys: 1)
- schemas.AgentTool.properties.rootAgent.deprecated (Total Keys: 1)
- schemas.ConversationLoggingSettings.properties.retentionWindow (Total Keys: 2)
- schemas.ErrorHandlingSettings.properties.endSessionConfig.$ref (Total Keys: 1)
- schemas.ErrorHandlingSettings.properties.fallbackResponseConfig.$ref (Total Keys: 1)
- schemas.ErrorHandlingSettingsEndSessionConfig (Total Keys: 3)
- schemas.ErrorHandlingSettingsFallbackResponseConfig (Total Keys: 6)
- schemas.ExecuteToolRequest.properties.mockConfig.$ref (Total Keys: 1)
- schemas.MockConfig (Total Keys: 5)
- schemas.MockedToolCall (Total Keys: 10)

#### ces:v1beta

The following keys were added:
- resources.projects.resources.locations.resources.apps.resources.evaluations.methods.export (Total Keys: 12)
- schemas.AgentTool.properties.agent.type (Total Keys: 1)
- schemas.AgentTool.properties.rootAgent.deprecated (Total Keys: 1)
- schemas.ConversationLoggingSettings.properties.retentionWindow (Total Keys: 2)
- schemas.ErrorHandlingSettings.properties.endSessionConfig.$ref (Total Keys: 1)
- schemas.ErrorHandlingSettings.properties.fallbackResponseConfig.$ref (Total Keys: 1)
- schemas.ErrorHandlingSettingsEndSessionConfig (Total Keys: 3)
- schemas.ErrorHandlingSettingsFallbackResponseConfig (Total Keys: 6)
- schemas.ExecuteToolRequest.properties.mockConfig.$ref (Total Keys: 1)
- schemas.ExportEvaluationsRequest (Total Keys: 7)
- schemas.ExportEvaluationsResponse (Total Keys: 8)
- schemas.ExportOptions (Total Keys: 4)
- schemas.ImportEvaluationsResponse.properties.evaluationResultImportFailureCount (Total Keys: 2)
- schemas.ImportEvaluationsResponse.properties.evaluationResults (Total Keys: 2)
- schemas.ImportEvaluationsResponse.properties.evaluationRunImportFailureCount (Total Keys: 2)
- schemas.ImportEvaluationsResponse.properties.evaluationRuns (Total Keys: 2)
- schemas.MockConfig (Total Keys: 5)
- schemas.MockedToolCall (Total Keys: 10)
---
 ...projects.locations.apps.conversations.html |   4 +
 docs/dyn/ces_v1.projects.locations.apps.html  |  69 ++++
 .../ces_v1.projects.locations.apps.tools.html |  18 +-
 ...s_v1.projects.locations.apps.toolsets.html |   3 +-
 ...s_v1.projects.locations.apps.versions.html |  52 ++-
 ...projects.locations.apps.conversations.html |   4 +
 ...a.projects.locations.apps.evaluations.html |  53 +++
 .../ces_v1beta.projects.locations.apps.html   |  72 +++-
 ..._v1beta.projects.locations.apps.tools.html |  18 +-
 ...beta.projects.locations.apps.toolsets.html |   3 +-
 ...beta.projects.locations.apps.versions.html |  52 ++-
 .../discovery_cache/documents/ces.v1.json     | 150 +++++++-
 .../discovery_cache/documents/ces.v1beta.json | 328 ++++++++++++++++--
 13 files changed, 762 insertions(+), 64 deletions(-)

diff --git a/docs/dyn/ces_v1.projects.locations.apps.conversations.html b/docs/dyn/ces_v1.projects.locations.apps.conversations.html
index 36b71b53af..044b38ae92 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.conversations.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.conversations.html
@@ -154,6 +154,7 @@ 

Method Details

LIVE - The conversation is from the live end user. SIMULATOR - The conversation is from the simulator. EVAL - The conversation is from the evaluation. + AGENT_TOOL - The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -178,6 +179,7 @@

Method Details

LIVE - The conversation is from the live end user. SIMULATOR - The conversation is from the simulator. EVAL - The conversation is from the evaluation. + AGENT_TOOL - The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -348,12 +350,14 @@

Method Details

LIVE - The conversation is from the live end user. SIMULATOR - The conversation is from the simulator. EVAL - The conversation is from the evaluation. + AGENT_TOOL - The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes. sources: string, Optional. Indicate the sources of the conversations. If not set, all available sources will be applied by default. (repeated) Allowed values SOURCE_UNSPECIFIED - Unspecified source. LIVE - The conversation is from the live end user. SIMULATOR - The conversation is from the simulator. EVAL - The conversation is from the evaluation. + AGENT_TOOL - The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/ces_v1.projects.locations.apps.html b/docs/dyn/ces_v1.projects.locations.apps.html index 52f57f3b45..b43f9646b1 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.html +++ b/docs/dyn/ces_v1.projects.locations.apps.html @@ -233,7 +233,16 @@

Method Details

"description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors). + "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details. + }, "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses. + "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language). + "a_key": "A String", + }, + "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal. + }, }, "etag": "A String", # Output only. 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. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. @@ -282,6 +291,7 @@

Method Details

}, "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app. "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions. + "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days. }, "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -473,6 +483,25 @@

Method Details

"context": { # Optional. The [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment for details) to be passed to the Python tool. "a_key": "", # Properties of the object. }, + "mockConfig": { # Mock tool calls configuration for the session. # Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses. + "mockedToolCalls": [ # Optional. All tool calls to mock for the duration of the session. + { # A mocked tool call. Expresses the target tool + a pattern to match against that tool's args / inputs. If the pattern matches, then the mock response will be returned. + "expectedArgsPattern": { # Required. A pattern to match against the args / inputs of all dispatched tool calls. If the tool call inputs match this pattern, then mock output will be returned. + "a_key": "", # Properties of the object. + }, + "mockResponse": { # Optional. The mock response / output to return if the tool call args / inputs match the pattern. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. Deprecated. Use tool_identifier instead. + "toolId": "A String", # Optional. The name of the tool to mock. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` + "toolset": { # A tool that is created from a toolset. # Optional. The toolset to mock. + "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. + "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` + }, + }, + ], + "unmatchedToolCallBehavior": "A String", # Required. Beavhior for tool calls that don't match any args patterns in mocked_tool_calls. + }, "tool": "A String", # Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool} "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -625,7 +654,16 @@

Method Details

"description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors). + "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details. + }, "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses. + "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language). + "a_key": "A String", + }, + "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal. + }, }, "etag": "A String", # Output only. 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. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. @@ -674,6 +712,7 @@

Method Details

}, "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app. "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions. + "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days. }, "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -914,7 +953,16 @@

Method Details

"description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors). + "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details. + }, "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses. + "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language). + "a_key": "A String", + }, + "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal. + }, }, "etag": "A String", # Output only. 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. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. @@ -963,6 +1011,7 @@

Method Details

}, "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app. "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions. + "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days. }, "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -1163,7 +1212,16 @@

Method Details

"description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors). + "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details. + }, "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses. + "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language). + "a_key": "A String", + }, + "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal. + }, }, "etag": "A String", # Output only. 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. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. @@ -1212,6 +1270,7 @@

Method Details

}, "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app. "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions. + "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days. }, "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -1391,7 +1450,16 @@

Method Details

"description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors). + "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details. + }, "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses. + "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language). + "a_key": "A String", + }, + "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal. + }, }, "etag": "A String", # Output only. 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. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. @@ -1440,6 +1508,7 @@

Method Details

}, "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app. "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions. + "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days. }, "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. diff --git a/docs/dyn/ces_v1.projects.locations.apps.tools.html b/docs/dyn/ces_v1.projects.locations.apps.tools.html index d852d72983..31e1effaa6 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.tools.html +++ b/docs/dyn/ces_v1.projects.locations.apps.tools.html @@ -112,9 +112,10 @@

Method Details

{ # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. @@ -577,9 +578,10 @@

Method Details

{ # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. @@ -1068,9 +1070,10 @@

Method Details

{ # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. @@ -1546,9 +1549,10 @@

Method Details

"tools": [ # The list of tools. { # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. @@ -2028,9 +2032,10 @@

Method Details

{ # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. @@ -2493,9 +2498,10 @@

Method Details

{ # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. diff --git a/docs/dyn/ces_v1.projects.locations.apps.toolsets.html b/docs/dyn/ces_v1.projects.locations.apps.toolsets.html index 90b1141f81..8f5752c218 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.toolsets.html +++ b/docs/dyn/ces_v1.projects.locations.apps.toolsets.html @@ -1028,9 +1028,10 @@

Method Details

"tools": [ # The list of tools that are included in the specified toolset. { # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. diff --git a/docs/dyn/ces_v1.projects.locations.apps.versions.html b/docs/dyn/ces_v1.projects.locations.apps.versions.html index bc695d2b74..6957809e2a 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1.projects.locations.apps.versions.html @@ -293,7 +293,16 @@

Method Details

"description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors). + "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details. + }, "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses. + "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language). + "a_key": "A String", + }, + "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal. + }, }, "etag": "A String", # Output only. 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. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. @@ -342,6 +351,7 @@

Method Details

}, "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app. "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions. + "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days. }, "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -624,9 +634,10 @@

Method Details

"tools": [ # Optional. List of tools in the app. { # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. @@ -1405,7 +1416,16 @@

Method Details

"description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors). + "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details. + }, "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses. + "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language). + "a_key": "A String", + }, + "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal. + }, }, "etag": "A String", # Output only. 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. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. @@ -1454,6 +1474,7 @@

Method Details

}, "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app. "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions. + "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days. }, "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -1736,9 +1757,10 @@

Method Details

"tools": [ # Optional. List of tools in the app. { # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. @@ -2542,7 +2564,16 @@

Method Details

"description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors). + "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details. + }, "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses. + "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language). + "a_key": "A String", + }, + "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal. + }, }, "etag": "A String", # Output only. 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. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. @@ -2591,6 +2622,7 @@

Method Details

}, "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app. "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions. + "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days. }, "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -2873,9 +2905,10 @@

Method Details

"tools": [ # Optional. List of tools in the app. { # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. @@ -3666,7 +3699,16 @@

Method Details

"description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors). + "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details. + }, "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses. + "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language). + "a_key": "A String", + }, + "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal. + }, }, "etag": "A String", # Output only. 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. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. @@ -3715,6 +3757,7 @@

Method Details

}, "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app. "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions. + "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days. }, "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -3997,9 +4040,10 @@

Method Details

"tools": [ # Optional. List of tools in the app. { # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html b/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html index 482a3e9632..e6d551d7e2 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html @@ -157,6 +157,7 @@

Method Details

LIVE - The conversation is from the live end user. SIMULATOR - The conversation is from the simulator. EVAL - The conversation is from the evaluation. + AGENT_TOOL - The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -223,6 +224,7 @@

Method Details

LIVE - The conversation is from the live end user. SIMULATOR - The conversation is from the simulator. EVAL - The conversation is from the evaluation. + AGENT_TOOL - The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -393,12 +395,14 @@

Method Details

LIVE - The conversation is from the live end user. SIMULATOR - The conversation is from the simulator. EVAL - The conversation is from the evaluation. + AGENT_TOOL - The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes. sources: string, Optional. Indicate the sources of the conversations. If not set, all available sources will be applied by default. (repeated) Allowed values SOURCE_UNSPECIFIED - Unspecified source. LIVE - The conversation is from the live end user. SIMULATOR - The conversation is from the simulator. EVAL - The conversation is from the evaluation. + AGENT_TOOL - The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html index 62223061d1..14e75e5188 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html @@ -88,6 +88,9 @@

Instance Methods

delete(name, etag=None, force=None, x__xgafv=None)

Deletes an evaluation.

+

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

+

Exports evaluations.

get(name, x__xgafv=None)

Gets details of the specified evaluation.

@@ -3162,6 +3165,56 @@

Method Details

}
+
+ export(parent, body=None, x__xgafv=None) +
Exports evaluations.
+
+Args:
+  parent: string, Required. The resource name of the app to export evaluations from. Format: `projects/{project}/locations/{location}/apps/{app}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for EvaluationService.ExportEvaluations.
+  "exportOptions": { # Options for exporting CES evaluation resources. # Optional. The export options for the evaluations.
+    "exportFormat": "A String", # Optional. The format to export the evaluation results in. Defaults to JSON if not specified.
+    "gcsUri": "A String", # Optional. The Google Cloud Storage URI to write the exported Evaluation Results to.
+  },
+  "includeEvaluationResults": True or False, # Optional. Includes evaluation results in the export. At least one of include_evaluation_results or include_evaluations must be set.
+  "includeEvaluations": True or False, # Optional. Includes evaluations in the export. At least one of include_evaluation_results or include_evaluations must be set.
+  "names": [ # Required. The resource names of the evaluations to export.
+    "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.
+  },
+}
+
+
get(name, x__xgafv=None)
Gets details of the specified evaluation.
diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.html b/docs/dyn/ces_v1beta.projects.locations.apps.html
index 58c7ab00dc..efcecbec93 100644
--- a/docs/dyn/ces_v1beta.projects.locations.apps.html
+++ b/docs/dyn/ces_v1beta.projects.locations.apps.html
@@ -270,7 +270,16 @@ 

Method Details

"description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors). + "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details. + }, "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses. + "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language). + "a_key": "A String", + }, + "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal. + }, }, "etag": "A String", # Output only. 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. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. @@ -338,6 +347,7 @@

Method Details

}, "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app. "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions. + "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days. }, "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -529,6 +539,25 @@

Method Details

"context": { # Optional. The [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment for details) to be passed to the Python tool. "a_key": "", # Properties of the object. }, + "mockConfig": { # Mock tool calls configuration for the session. # Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses. + "mockedToolCalls": [ # Optional. All tool calls to mock for the duration of the session. + { # A mocked tool call. Expresses the target tool + a pattern to match against that tool's args / inputs. If the pattern matches, then the mock response will be returned. + "expectedArgsPattern": { # Required. A pattern to match against the args / inputs of all dispatched tool calls. If the tool call inputs match this pattern, then mock output will be returned. + "a_key": "", # Properties of the object. + }, + "mockResponse": { # Optional. The mock response / output to return if the tool call args / inputs match the pattern. + "a_key": "", # Properties of the object. + }, + "tool": "A String", # Required. Deprecated. Use tool_identifier instead. + "toolId": "A String", # Optional. The name of the tool to mock. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` + "toolset": { # A tool that is created from a toolset. # Optional. The toolset to mock. + "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. + "toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` + }, + }, + ], + "unmatchedToolCallBehavior": "A String", # Required. Beavhior for tool calls that don't match any args patterns in mocked_tool_calls. + }, "tool": "A String", # Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool} "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -787,9 +816,10 @@

Method Details

], "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. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. @@ -1499,7 +1529,16 @@

Method Details

"description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors). + "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details. + }, "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses. + "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language). + "a_key": "A String", + }, + "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal. + }, }, "etag": "A String", # Output only. 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. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. @@ -1567,6 +1606,7 @@

Method Details

}, "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app. "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions. + "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days. }, "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -1858,7 +1898,16 @@

Method Details

"description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors). + "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details. + }, "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses. + "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language). + "a_key": "A String", + }, + "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal. + }, }, "etag": "A String", # Output only. 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. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. @@ -1926,6 +1975,7 @@

Method Details

}, "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app. "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions. + "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days. }, "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -2126,7 +2176,16 @@

Method Details

"description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors). + "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details. + }, "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses. + "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language). + "a_key": "A String", + }, + "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal. + }, }, "etag": "A String", # Output only. 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. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. @@ -2194,6 +2253,7 @@

Method Details

}, "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app. "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions. + "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days. }, "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -2373,7 +2433,16 @@

Method Details

"description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors). + "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details. + }, "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses. + "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language). + "a_key": "A String", + }, + "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal. + }, }, "etag": "A String", # Output only. 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. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. @@ -2441,6 +2510,7 @@

Method Details

}, "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app. "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions. + "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days. }, "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.tools.html b/docs/dyn/ces_v1beta.projects.locations.apps.tools.html index edf52d8014..1a319d56f1 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.tools.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.tools.html @@ -112,9 +112,10 @@

Method Details

{ # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. @@ -577,9 +578,10 @@

Method Details

{ # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. @@ -1068,9 +1070,10 @@

Method Details

{ # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. @@ -1546,9 +1549,10 @@

Method Details

"tools": [ # The list of tools. { # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. @@ -2028,9 +2032,10 @@

Method Details

{ # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. @@ -2493,9 +2498,10 @@

Method Details

{ # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html b/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html index 8e83dfe6ed..edf16598fe 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html @@ -1028,9 +1028,10 @@

Method Details

"tools": [ # The list of tools that are included in the specified toolset. { # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html index ac6cedaab0..c597954799 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html @@ -293,7 +293,16 @@

Method Details

"description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors). + "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details. + }, "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses. + "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language). + "a_key": "A String", + }, + "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal. + }, }, "etag": "A String", # Output only. 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. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. @@ -361,6 +370,7 @@

Method Details

}, "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app. "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions. + "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days. }, "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -643,9 +653,10 @@

Method Details

"tools": [ # Optional. List of tools in the app. { # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. @@ -1424,7 +1435,16 @@

Method Details

"description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors). + "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details. + }, "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses. + "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language). + "a_key": "A String", + }, + "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal. + }, }, "etag": "A String", # Output only. 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. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. @@ -1492,6 +1512,7 @@

Method Details

}, "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app. "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions. + "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days. }, "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -1774,9 +1795,10 @@

Method Details

"tools": [ # Optional. List of tools in the app. { # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. @@ -2580,7 +2602,16 @@

Method Details

"description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors). + "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details. + }, "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses. + "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language). + "a_key": "A String", + }, + "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal. + }, }, "etag": "A String", # Output only. 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. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. @@ -2648,6 +2679,7 @@

Method Details

}, "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app. "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions. + "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days. }, "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -2930,9 +2962,10 @@

Method Details

"tools": [ # Optional. List of tools in the app. { # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. @@ -3723,7 +3756,16 @@

Method Details

"description": "A String", # Optional. Human-readable description of the app. "displayName": "A String", # Required. Display name of the app. "errorHandlingSettings": { # Settings to describe how errors should be handled in the app. # Optional. Error handling settings of the app. + "endSessionConfig": { # Configuration for ending the session in case of system errors (e.g. LLM errors). # Optional. Configuration for ending the session in case of system errors (e.g. LLM errors). + "escalateSession": True or False, # Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details. + }, "errorHandlingStrategy": "A String", # Optional. The strategy to use for error handling. + "fallbackResponseConfig": { # Configuration for handling fallback responses. # Optional. Configuration for handling fallback responses. + "customFallbackMessages": { # Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language). + "a_key": "A String", + }, + "maxFallbackAttempts": 42, # Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal. + }, }, "etag": "A String", # Output only. 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. "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Optional. The evaluation thresholds for the app. @@ -3791,6 +3833,7 @@

Method Details

}, "conversationLoggingSettings": { # Settings to describe the conversation logging behaviors for the app. # Optional. Settings to describe the conversation logging behaviors for the app. "disableConversationLogging": True or False, # Optional. Whether to disable conversation logging for the sessions. + "retentionWindow": "A String", # Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days. }, "evaluationAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -4073,9 +4116,10 @@

Method Details

"tools": [ # Optional. List of tools in the app. { # A tool represents an action that the CES agent can take to achieve certain goals. "agentTool": { # Represents a tool that allows the agent to call another agent. # Optional. The agent tool. + "agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "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}` + "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. 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. diff --git a/googleapiclient/discovery_cache/documents/ces.v1.json b/googleapiclient/discovery_cache/documents/ces.v1.json index ff77f9c5c8..481246ba9c 100644 --- a/googleapiclient/discovery_cache/documents/ces.v1.json +++ b/googleapiclient/discovery_cache/documents/ces.v1.json @@ -806,13 +806,15 @@ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", -"EVAL" +"EVAL", +"AGENT_TOOL" ], "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", -"The conversation is from the evaluation." +"The conversation is from the evaluation.", +"The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "location": "query", "type": "string" @@ -850,13 +852,15 @@ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", -"EVAL" +"EVAL", +"AGENT_TOOL" ], "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", -"The conversation is from the evaluation." +"The conversation is from the evaluation.", +"The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "location": "query", "type": "string" @@ -909,13 +913,15 @@ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", -"EVAL" +"EVAL", +"AGENT_TOOL" ], "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", -"The conversation is from the evaluation." +"The conversation is from the evaluation.", +"The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "location": "query", "type": "string" @@ -926,13 +932,15 @@ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", -"EVAL" +"EVAL", +"AGENT_TOOL" ], "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", -"The conversation is from the evaluation." +"The conversation is from the evaluation.", +"The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "location": "query", "repeated": true, @@ -2275,7 +2283,7 @@ } } }, -"revision": "20260325", +"revision": "20260408", "rootUrl": "https://ces.googleapis.com/", "schemas": { "Action": { @@ -2536,6 +2544,10 @@ "description": "Represents a tool that allows the agent to call another agent.", "id": "AgentTool", "properties": { +"agent": { +"description": "Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`", +"type": "string" +}, "description": { "description": "Optional. Description of the tool's purpose.", "type": "string" @@ -2545,7 +2557,8 @@ "type": "string" }, "rootAgent": { -"description": "Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`", +"deprecated": true, +"description": "Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`", "type": "string" } }, @@ -3581,13 +3594,15 @@ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", -"EVAL" +"EVAL", +"AGENT_TOOL" ], "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", -"The conversation is from the evaluation." +"The conversation is from the evaluation.", +"The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "readOnly": true, "type": "string" @@ -3621,6 +3636,11 @@ "disableConversationLogging": { "description": "Optional. Whether to disable conversation logging for the sessions.", "type": "boolean" +}, +"retentionWindow": { +"description": "Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days.", +"format": "google-duration", +"type": "string" } }, "type": "object" @@ -4193,6 +4213,10 @@ "description": "Settings to describe how errors should be handled in the app.", "id": "ErrorHandlingSettings", "properties": { +"endSessionConfig": { +"$ref": "ErrorHandlingSettingsEndSessionConfig", +"description": "Optional. Configuration for ending the session in case of system errors (e.g. LLM errors)." +}, "errorHandlingStrategy": { "description": "Optional. The strategy to use for error handling.", "enum": [ @@ -4208,6 +4232,40 @@ "An EndSession signal will be emitted in case of system errors (e.g. LLM errors)." ], "type": "string" +}, +"fallbackResponseConfig": { +"$ref": "ErrorHandlingSettingsFallbackResponseConfig", +"description": "Optional. Configuration for handling fallback responses." +} +}, +"type": "object" +}, +"ErrorHandlingSettingsEndSessionConfig": { +"description": "Configuration for ending the session in case of system errors (e.g. LLM errors).", +"id": "ErrorHandlingSettingsEndSessionConfig", +"properties": { +"escalateSession": { +"description": "Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details.", +"type": "boolean" +} +}, +"type": "object" +}, +"ErrorHandlingSettingsFallbackResponseConfig": { +"description": "Configuration for handling fallback responses.", +"id": "ErrorHandlingSettingsFallbackResponseConfig", +"properties": { +"customFallbackMessages": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language).", +"type": "object" +}, +"maxFallbackAttempts": { +"description": "Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal.", +"format": "int32", +"type": "integer" } }, "type": "object" @@ -4431,6 +4489,10 @@ "description": "Optional. The [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment for details) to be passed to the Python tool.", "type": "object" }, +"mockConfig": { +"$ref": "MockConfig", +"description": "Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses." +}, "tool": { "description": "Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}", "type": "string" @@ -5504,6 +5566,70 @@ }, "type": "object" }, +"MockConfig": { +"description": "Mock tool calls configuration for the session.", +"id": "MockConfig", +"properties": { +"mockedToolCalls": { +"description": "Optional. All tool calls to mock for the duration of the session.", +"items": { +"$ref": "MockedToolCall" +}, +"type": "array" +}, +"unmatchedToolCallBehavior": { +"description": "Required. Beavhior for tool calls that don't match any args patterns in mocked_tool_calls.", +"enum": [ +"UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED", +"FAIL", +"PASS_THROUGH" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Throw an error for any tool calls that don't match a mock expected input pattern.", +"For unmatched tool calls, pass the tool call through to real tool." +], +"type": "string" +} +}, +"type": "object" +}, +"MockedToolCall": { +"description": "A mocked tool call. Expresses the target tool + a pattern to match against that tool's args / inputs. If the pattern matches, then the mock response will be returned.", +"id": "MockedToolCall", +"properties": { +"expectedArgsPattern": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Required. A pattern to match against the args / inputs of all dispatched tool calls. If the tool call inputs match this pattern, then mock output will be returned.", +"type": "object" +}, +"mockResponse": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. The mock response / output to return if the tool call args / inputs match the pattern.", +"type": "object" +}, +"tool": { +"deprecated": true, +"description": "Required. Deprecated. Use tool_identifier instead.", +"type": "string" +}, +"toolId": { +"description": "Optional. The name of the tool to mock. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", +"type": "string" +}, +"toolset": { +"$ref": "ToolsetTool", +"description": "Optional. The toolset to mock." +} +}, +"type": "object" +}, "ModelSettings": { "description": "Model settings contains various configurations for the LLM model.", "id": "ModelSettings", diff --git a/googleapiclient/discovery_cache/documents/ces.v1beta.json b/googleapiclient/discovery_cache/documents/ces.v1beta.json index 7809468a46..a37c4256d0 100644 --- a/googleapiclient/discovery_cache/documents/ces.v1beta.json +++ b/googleapiclient/discovery_cache/documents/ces.v1beta.json @@ -983,13 +983,15 @@ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", -"EVAL" +"EVAL", +"AGENT_TOOL" ], "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", -"The conversation is from the evaluation." +"The conversation is from the evaluation.", +"The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "location": "query", "type": "string" @@ -1056,13 +1058,15 @@ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", -"EVAL" +"EVAL", +"AGENT_TOOL" ], "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", -"The conversation is from the evaluation." +"The conversation is from the evaluation.", +"The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "location": "query", "type": "string" @@ -1115,13 +1119,15 @@ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", -"EVAL" +"EVAL", +"AGENT_TOOL" ], "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", -"The conversation is from the evaluation." +"The conversation is from the evaluation.", +"The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "location": "query", "type": "string" @@ -1132,13 +1138,15 @@ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", -"EVAL" +"EVAL", +"AGENT_TOOL" ], "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", -"The conversation is from the evaluation." +"The conversation is from the evaluation.", +"The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "location": "query", "repeated": true, @@ -1857,6 +1865,35 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"export": { +"description": "Exports evaluations.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations:export", +"httpMethod": "POST", +"id": "ces.projects.locations.apps.evaluations.export", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the app to export evaluations from. Format: `projects/{project}/locations/{location}/apps/{app}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/evaluations:export", +"request": { +"$ref": "ExportEvaluationsRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/ces", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets details of the specified evaluation.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}", @@ -3447,7 +3484,7 @@ } } }, -"revision": "20260325", +"revision": "20260408", "rootUrl": "https://ces.googleapis.com/", "schemas": { "Action": { @@ -3708,6 +3745,10 @@ "description": "Represents a tool that allows the agent to call another agent.", "id": "AgentTool", "properties": { +"agent": { +"description": "Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`", +"type": "string" +}, "description": { "description": "Optional. Description of the tool's purpose.", "type": "string" @@ -3717,7 +3758,8 @@ "type": "string" }, "rootAgent": { -"description": "Optional. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`", +"deprecated": true, +"description": "Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`", "type": "string" } }, @@ -5013,13 +5055,15 @@ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", -"EVAL" +"EVAL", +"AGENT_TOOL" ], "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", -"The conversation is from the evaluation." +"The conversation is from the evaluation.", +"The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "readOnly": true, "type": "string" @@ -5053,6 +5097,11 @@ "disableConversationLogging": { "description": "Optional. Whether to disable conversation logging for the sessions.", "type": "boolean" +}, +"retentionWindow": { +"description": "Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days.", +"format": "google-duration", +"type": "string" } }, "type": "object" @@ -5631,6 +5680,10 @@ "description": "Settings to describe how errors should be handled in the app.", "id": "ErrorHandlingSettings", "properties": { +"endSessionConfig": { +"$ref": "ErrorHandlingSettingsEndSessionConfig", +"description": "Optional. Configuration for ending the session in case of system errors (e.g. LLM errors)." +}, "errorHandlingStrategy": { "description": "Optional. The strategy to use for error handling.", "enum": [ @@ -5646,6 +5699,40 @@ "An EndSession signal will be emitted in case of system errors (e.g. LLM errors)." ], "type": "string" +}, +"fallbackResponseConfig": { +"$ref": "ErrorHandlingSettingsFallbackResponseConfig", +"description": "Optional. Configuration for handling fallback responses." +} +}, +"type": "object" +}, +"ErrorHandlingSettingsEndSessionConfig": { +"description": "Configuration for ending the session in case of system errors (e.g. LLM errors).", +"id": "ErrorHandlingSettingsEndSessionConfig", +"properties": { +"escalateSession": { +"description": "Optional. Whether to escalate the session in EndSession. If session is escalated, metadata in EndSession will contain `session_escalated = true`. See https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent for details.", +"type": "boolean" +} +}, +"type": "object" +}, +"ErrorHandlingSettingsFallbackResponseConfig": { +"description": "Configuration for handling fallback responses.", +"id": "ErrorHandlingSettingsFallbackResponseConfig", +"properties": { +"customFallbackMessages": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language).", +"type": "object" +}, +"maxFallbackAttempts": { +"description": "Optional. The maximum number of fallback attempts to make before the agent emitting EndSession Signal.", +"format": "int32", +"type": "integer" } }, "type": "object" @@ -6285,12 +6372,14 @@ "enum": [ "OUTCOME_UNSPECIFIED", "PASS", -"FAIL" +"FAIL", +"SKIPPED" ], "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", -"Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met." +"Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", +"Evaluation/Expectation was skipped." ], "readOnly": true, "type": "string" @@ -6373,12 +6462,14 @@ "enum": [ "OUTCOME_UNSPECIFIED", "PASS", -"FAIL" +"FAIL", +"SKIPPED" ], "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", -"Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met." +"Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", +"Evaluation/Expectation was skipped." ], "readOnly": true, "type": "string" @@ -6425,12 +6516,14 @@ "enum": [ "OUTCOME_UNSPECIFIED", "PASS", -"FAIL" +"FAIL", +"SKIPPED" ], "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", -"Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met." +"Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", +"Evaluation/Expectation was skipped." ], "readOnly": true, "type": "string" @@ -6463,12 +6556,14 @@ "enum": [ "OUTCOME_UNSPECIFIED", "PASS", -"FAIL" +"FAIL", +"SKIPPED" ], "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", -"Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met." +"Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", +"Evaluation/Expectation was skipped." ], "readOnly": true, "type": "string" @@ -6612,12 +6707,14 @@ "enum": [ "OUTCOME_UNSPECIFIED", "PASS", -"FAIL" +"FAIL", +"SKIPPED" ], "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", -"Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met." +"Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", +"Evaluation/Expectation was skipped." ], "readOnly": true, "type": "string" @@ -6654,12 +6751,14 @@ "enum": [ "OUTCOME_UNSPECIFIED", "PASS", -"FAIL" +"FAIL", +"SKIPPED" ], "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", -"Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met." +"Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", +"Evaluation/Expectation was skipped." ], "readOnly": true, "type": "string" @@ -6820,12 +6919,14 @@ "enum": [ "OUTCOME_UNSPECIFIED", "PASS", -"FAIL" +"FAIL", +"SKIPPED" ], "enumDescriptions": [ "Evaluation outcome is not specified.", "Evaluation/Expectation passed. In the case of an evaluation, this means that all expectations were met.", -"Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met." +"Evaluation/Expectation failed. In the case of an evaluation, this means that at least one expectation was not met.", +"Evaluation/Expectation was skipped." ], "readOnly": true, "type": "string" @@ -7517,6 +7618,10 @@ "description": "Optional. The [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment for details) to be passed to the Python tool.", "type": "object" }, +"mockConfig": { +"$ref": "MockConfig", +"description": "Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses." +}, "tool": { "description": "Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}", "type": "string" @@ -7612,6 +7717,81 @@ }, "type": "object" }, +"ExportEvaluationsRequest": { +"description": "Request message for EvaluationService.ExportEvaluations.", +"id": "ExportEvaluationsRequest", +"properties": { +"exportOptions": { +"$ref": "ExportOptions", +"description": "Optional. The export options for the evaluations." +}, +"includeEvaluationResults": { +"description": "Optional. Includes evaluation results in the export. At least one of include_evaluation_results or include_evaluations must be set.", +"type": "boolean" +}, +"includeEvaluations": { +"description": "Optional. Includes evaluations in the export. At least one of include_evaluation_results or include_evaluations must be set.", +"type": "boolean" +}, +"names": { +"description": "Required. The resource names of the evaluations to export.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ExportEvaluationsResponse": { +"description": "Response message for EvaluationService.ExportEvaluations.", +"id": "ExportEvaluationsResponse", +"properties": { +"evaluationsContent": { +"description": "The content of the exported Evaluations. This will be populated if gcs_uri was not specified in the request.", +"format": "byte", +"type": "string" +}, +"evaluationsUri": { +"description": "The Google Cloud Storage URI folder where the exported evaluations were written. This will be populated if gcs_uri was specified in the request.", +"type": "string" +}, +"failedEvaluations": { +"additionalProperties": { +"type": "string" +}, +"description": "Output only. A map of evaluation resource names that could not be exported, to the reason why they failed.", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, +"ExportOptions": { +"description": "Options for exporting CES evaluation resources.", +"id": "ExportOptions", +"properties": { +"exportFormat": { +"description": "Optional. The format to export the evaluation results in. Defaults to JSON if not specified.", +"enum": [ +"EXPORT_FORMAT_UNSPECIFIED", +"JSON", +"YAML" +], +"enumDescriptions": [ +"Unspecified format.", +"JSON format.", +"YAML format." +], +"type": "string" +}, +"gcsUri": { +"description": "Optional. The Google Cloud Storage URI to write the exported Evaluation Results to.", +"type": "string" +} +}, +"type": "object" +}, "ExpressionCondition": { "description": "Expression condition based on session state.", "id": "ExpressionCondition", @@ -8043,13 +8223,15 @@ "SOURCE_UNSPECIFIED", "LIVE", "SIMULATOR", -"EVAL" +"EVAL", +"AGENT_TOOL" ], "enumDescriptions": [ "Unspecified source.", "The conversation is from the live end user.", "The conversation is from the simulator.", -"The conversation is from the evaluation." +"The conversation is from the evaluation.", +"The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes." ], "type": "string" } @@ -8583,6 +8765,30 @@ }, "type": "array" }, +"evaluationResultImportFailureCount": { +"description": "The number of evaluation results that either failed to import entirely or completed import with one or more errors.", +"format": "int32", +"type": "integer" +}, +"evaluationResults": { +"description": "The list of evaluation results that were imported into the app.", +"items": { +"$ref": "EvaluationResult" +}, +"type": "array" +}, +"evaluationRunImportFailureCount": { +"description": "The number of evaluation runs that either failed to import entirely or completed import with one or more errors.", +"format": "int32", +"type": "integer" +}, +"evaluationRuns": { +"description": "The list of evaluation runs that were imported into the app.", +"items": { +"$ref": "EvaluationRun" +}, +"type": "array" +}, "evaluations": { "description": "The list of evaluations that were imported into the app.", "items": { @@ -8591,7 +8797,7 @@ "type": "array" }, "importFailureCount": { -"description": "The number of evaluations that were not imported due to errors.", +"description": "The number of evaluations that either failed to import entirely or completed import with one or more errors.", "format": "int32", "type": "integer" } @@ -9333,6 +9539,70 @@ }, "type": "object" }, +"MockConfig": { +"description": "Mock tool calls configuration for the session.", +"id": "MockConfig", +"properties": { +"mockedToolCalls": { +"description": "Optional. All tool calls to mock for the duration of the session.", +"items": { +"$ref": "MockedToolCall" +}, +"type": "array" +}, +"unmatchedToolCallBehavior": { +"description": "Required. Beavhior for tool calls that don't match any args patterns in mocked_tool_calls.", +"enum": [ +"UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED", +"FAIL", +"PASS_THROUGH" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Throw an error for any tool calls that don't match a mock expected input pattern.", +"For unmatched tool calls, pass the tool call through to real tool." +], +"type": "string" +} +}, +"type": "object" +}, +"MockedToolCall": { +"description": "A mocked tool call. Expresses the target tool + a pattern to match against that tool's args / inputs. If the pattern matches, then the mock response will be returned.", +"id": "MockedToolCall", +"properties": { +"expectedArgsPattern": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Required. A pattern to match against the args / inputs of all dispatched tool calls. If the tool call inputs match this pattern, then mock output will be returned.", +"type": "object" +}, +"mockResponse": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. The mock response / output to return if the tool call args / inputs match the pattern.", +"type": "object" +}, +"tool": { +"deprecated": true, +"description": "Required. Deprecated. Use tool_identifier instead.", +"type": "string" +}, +"toolId": { +"description": "Optional. The name of the tool to mock. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", +"type": "string" +}, +"toolset": { +"$ref": "ToolsetTool", +"description": "Optional. The toolset to mock." +} +}, +"type": "object" +}, "ModelSettings": { "description": "Model settings contains various configurations for the LLM model.", "id": "ModelSettings", From 12da6e3efa7ff71143b56d1ab2cd3412b333f9ef Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:40:58 +0000 Subject: [PATCH 06/32] feat(chat): update the api #### chat:v1 The following keys were added: - resources.spaces.methods.findGroupChats (Total Keys: 17) - schemas.FindGroupChatsResponse (Total Keys: 5) --- docs/dyn/chat_v1.spaces.html | 121 ++++++++++++++++++ docs/dyn/chat_v1.spaces.messages.html | 8 +- docs/dyn/chat_v1.spaces.spaceEvents.html | 8 +- docs/dyn/chat_v1.users.sections.html | 38 +++--- docs/dyn/chat_v1.users.sections.items.html | 18 +-- .../discovery_cache/documents/chat.v1.json | 107 +++++++++++++--- 6 files changed, 244 insertions(+), 56 deletions(-) diff --git a/docs/dyn/chat_v1.spaces.html b/docs/dyn/chat_v1.spaces.html index 493a77b27c..85336953b2 100644 --- a/docs/dyn/chat_v1.spaces.html +++ b/docs/dyn/chat_v1.spaces.html @@ -104,6 +104,12 @@

Instance Methods

findDirectMessage(name=None, x__xgafv=None)

Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). With [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), returns the direct message space between the specified user and the calling Chat app. With [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), returns the direct message space between the specified user and the authenticated user. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces`

+

+ findGroupChats(pageSize=None, pageToken=None, spaceView=None, users=None, x__xgafv=None)

+

[Developer Preview](https://developers.google.com/workspace/preview): Returns all spaces with `spaceType == GROUP_CHAT`, whose human memberships contain exactly the calling user, and the users specified in `FindGroupChatsRequest.users`. Only members that have joined the conversation are supported. For an example, see [Find group chats](https://developers.google.com/workspace/chat/find-group-chats). If the calling user blocks, or is blocked by, some users, and no spaces with the entire specified set of users are found, this method returns spaces that don't include the blocked or blocking users. The specified set of users must contain only human (non-app) memberships. A request that contains non-human users doesn't return any spaces. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships`

+

+ findGroupChats_next()

+

Retrieves the next page of results.

get(name, useAdminAccess=None, x__xgafv=None)

Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.spaces` with [administrator approval](https://support.google.com/a?p=chat-app-auth) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces` App authentication has the following limitations: - `space.access_settings` is only populated when using the `chat.app.spaces` scope. - `space.predefind_permission_settings` and `space.permission_settings` are only populated when using the `chat.app.spaces` scope, and only for spaces the app created.

@@ -502,6 +508,121 @@

Method Details

}
+
+ findGroupChats(pageSize=None, pageToken=None, spaceView=None, users=None, x__xgafv=None) +
[Developer Preview](https://developers.google.com/workspace/preview): Returns all spaces with `spaceType == GROUP_CHAT`, whose human memberships contain exactly the calling user, and the users specified in `FindGroupChatsRequest.users`. Only members that have joined the conversation are supported. For an example, see [Find group chats](https://developers.google.com/workspace/chat/find-group-chats). If the calling user blocks, or is blocked by, some users, and no spaces with the entire specified set of users are found, this method returns spaces that don't include the blocked or blocking users. The specified set of users must contain only human (non-app) memberships. A request that contains non-human users doesn't return any spaces. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships`
+
+Args:
+  pageSize: integer, Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 10 spaces are returned. The maximum value is 30. If you use a value more than 30, it's automatically changed to 30. Negative values return an `INVALID_ARGUMENT` error.
+  pageToken: string, Optional. A page token, received from a previous call to find group chats. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the token. Passing different values may lead to unexpected results.
+  spaceView: string, Requested space view type. If unset, defaults to `SPACE_VIEW_RESOURCE_NAME_ONLY`. Requests that specify `SPACE_VIEW_EXPANDED` must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly.
+    Allowed values
+      SPACE_VIEW_UNSPECIFIED - The default / unset value.
+      SPACE_VIEW_RESOURCE_NAME_ONLY - Populates only the Space resource name.
+      SPACE_VIEW_EXPANDED - Populates Space resource fields. Note: the `permissionSettings` field will not be populated. Requests that specify SPACE_VIEW_EXPANDED must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly.
+  users: string, Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request. The maximum number of users that can be specified in a single request is `49`. Format: `users/{user}`, where `{user}` is either the `id` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, to find all group chats with the calling user and two other users, with People API profile IDs `123456789` and `987654321`, you can use `users/123456789` and `users/987654321`. You can also use the email as an alias for `{user}`. For example, `users/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. (repeated)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A response containing group chat spaces with exactly the calling user and the requested users. [Developer Preview](https://developers.google.com/workspace/preview):
+  "nextPageToken": "A String", # A token that you can send as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.
+  "spaces": [ # List of spaces in the requested (or first) page.
+    { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app.
+      "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`.
+        "accessState": "A String", # Output only. Indicates the access state of the space.
+        "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+      },
+      "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging.
+      "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`.
+      "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users.
+      "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.
+      "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.
+      "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+      "importModeExpireTime": "A String", # Output only. The time when the space will be automatically deleted by the system if it remains in import mode. Each space created in import mode must exit this mode before this expire time using `spaces.completeImport`. This field is only populated for spaces that were created with import mode.
+      "lastActiveTime": "A String", # Output only. Timestamp of the last message in the space.
+      "membershipCount": { # Represents the count of memberships of a space, grouped into categories. # Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`.
+        "joinedDirectHumanUserCount": 42, # Output only. Count of human users that have directly joined the space, not counting users joined by having membership in a joined group.
+        "joinedGroupCount": 42, # Output only. Count of all groups that have directly joined the space.
+      },
+      "name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`.
+      "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
+        "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space.
+          "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.
+          "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission.
+          "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.
+        },
+        "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space.
+          "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.
+          "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission.
+          "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.
+        },
+        "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space.
+          "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.
+          "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission.
+          "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.
+        },
+        "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines.
+          "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.
+          "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission.
+          "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.
+        },
+        "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space.
+          "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.
+          "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission.
+          "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.
+        },
+        "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space.
+          "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.
+          "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission.
+          "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.
+        },
+        "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off.
+          "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.
+          "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission.
+          "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.
+        },
+        "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space.
+          "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.
+          "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission.
+          "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission.
+        },
+      },
+      "predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)
+      "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human.
+      "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules.
+        "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters.
+        "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters.
+      },
+      "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space.
+      "spaceThreadingState": "A String", # Output only. The threading state in the Chat space.
+      "spaceType": "A String", # Optional. The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.
+      "spaceUri": "A String", # Output only. The URI for a user to access the space.
+      "threaded": True or False, # Output only. Deprecated: Use `spaceThreadingState` instead. Whether messages are threaded in this space.
+      "type": "A String", # Output only. Deprecated: Use `space_type` instead. The type of a space.
+    },
+  ],
+}
+
+ +
+ findGroupChats_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.
+        
+
+
get(name, useAdminAccess=None, x__xgafv=None)
Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.spaces` with [administrator approval](https://support.google.com/a?p=chat-app-auth) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces` App authentication has the following limitations: - `space.access_settings` is only populated when using the `chat.app.spaces` scope. - `space.predefind_permission_settings` and `space.permission_settings` are only populated when using the `chat.app.spaces` scope, and only for spaces the app created.
diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html
index ae1c354dfb..4f60d222b5 100644
--- a/docs/dyn/chat_v1.spaces.messages.html
+++ b/docs/dyn/chat_v1.spaces.messages.html
@@ -95,10 +95,10 @@ 

Instance Methods

Deletes a message. For an example, see [Delete a message](https://developers.google.com/workspace/chat/delete-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only delete messages created by the calling Chat app.

get(name, x__xgafv=None)

-

Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot`: When using this authorization scope, this method returns details about a message the Chat app has access to, like direct messages and [slash commands](https://developers.google.com/workspace/chat/slash-commands) that invoke the Chat app. - `https://www.googleapis.com/auth/chat.app.messages.readonly` with [administrator approval](https://support.google.com/a?p=chat-app-auth) (available in [Developer Preview](https://developers.google.com/workspace/preview)). When using this authentication scope, this method returns details about a public message in a space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` Note: Might return a message from a blocked member or space.

+

Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot`: When using this authorization scope, this method returns details about a message the Chat app has access to, like direct messages and [slash commands](https://developers.google.com/workspace/chat/slash-commands) that invoke the Chat app. - `https://www.googleapis.com/auth/chat.app.messages.readonly` with [administrator approval](https://support.google.com/a?p=chat-app-auth). When using this authentication scope, this method returns details about a public message in a space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` Note: Might return a message from a blocked member or space.

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

-

Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. System messages, like those announcing new space members, aren't included. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, `{}`. For an example, see [List messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) with the authorization scope: - `https://www.googleapis.com/auth/chat.app.messages.readonly`. When using this authentication scope, this method only returns public messages in a space. It doesn't include private messages. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)

+

Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. System messages, like those announcing new space members, aren't included. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, `{}`. For an example, see [List messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the authorization scope: - `https://www.googleapis.com/auth/chat.app.messages.readonly`. When using this authentication scope, this method only returns public messages in a space. It doesn't include private messages. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)

list_next()

Retrieves the next page of results.

@@ -6201,7 +6201,7 @@

Method Details

get(name, x__xgafv=None) -
Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot`: When using this authorization scope, this method returns details about a message the Chat app has access to, like direct messages and [slash commands](https://developers.google.com/workspace/chat/slash-commands) that invoke the Chat app. - `https://www.googleapis.com/auth/chat.app.messages.readonly` with [administrator approval](https://support.google.com/a?p=chat-app-auth) (available in [Developer Preview](https://developers.google.com/workspace/preview)). When using this authentication scope, this method returns details about a public message in a space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` Note: Might return a message from a blocked member or space.
+  
Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot`: When using this authorization scope, this method returns details about a message the Chat app has access to, like direct messages and [slash commands](https://developers.google.com/workspace/chat/slash-commands) that invoke the Chat app. - `https://www.googleapis.com/auth/chat.app.messages.readonly` with [administrator approval](https://support.google.com/a?p=chat-app-auth). When using this authentication scope, this method returns details about a public message in a space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` Note: Might return a message from a blocked member or space.
 
 Args:
   name: string, Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message). (required)
@@ -9236,7 +9236,7 @@ 

Method Details

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None) -
Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. System messages, like those announcing new space members, aren't included. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, `{}`. For an example, see [List messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) with the authorization scope: - `https://www.googleapis.com/auth/chat.app.messages.readonly`. When using this authentication scope, this method only returns public messages in a space. It doesn't include private messages. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)
+  
Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. System messages, like those announcing new space members, aren't included. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, `{}`. For an example, see [List messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the authorization scope: - `https://www.googleapis.com/auth/chat.app.messages.readonly`. When using this authentication scope, this method only returns public messages in a space. It doesn't include private messages. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)
 
 Args:
   parent: string, Required. The resource name of the space to list messages from. Format: `spaces/{space}` (required)
diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html
index 01e2fefa6d..8b649f6e61 100644
--- a/docs/dyn/chat_v1.spaces.spaceEvents.html
+++ b/docs/dyn/chat_v1.spaces.spaceEvents.html
@@ -79,10 +79,10 @@ 

Instance Methods

Close httplib2 connections.

get(name, x__xgafv=None)

-

Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated caller must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).

+

Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.spaces.readonly` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - `https://www.googleapis.com/auth/chat.app.memberships.readonly` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated caller must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).

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

-

Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated caller must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).

+

Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.spaces.readonly` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - `https://www.googleapis.com/auth/chat.app.memberships.readonly` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated caller must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).

list_next()

Retrieves the next page of results.

@@ -94,7 +94,7 @@

Method Details

get(name, x__xgafv=None) -
Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated caller must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).
+  
Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.spaces.readonly` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - `https://www.googleapis.com/auth/chat.app.memberships.readonly` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated caller must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).
 
 Args:
   name: string, Required. The resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}` (required)
@@ -18641,7 +18641,7 @@ 

Method Details

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated caller must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).
+  
Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.spaces.readonly` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - `https://www.googleapis.com/auth/chat.app.memberships.readonly` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated caller must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).
 
 Args:
   parent: string, Required. Resource name of the [Google Chat space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) where the events occurred. Format: `spaces/{space}`. (required)
diff --git a/docs/dyn/chat_v1.users.sections.html b/docs/dyn/chat_v1.users.sections.html
index 63314e4479..485538f972 100644
--- a/docs/dyn/chat_v1.users.sections.html
+++ b/docs/dyn/chat_v1.users.sections.html
@@ -84,22 +84,22 @@ 

Instance Methods

Close httplib2 connections.

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

-

[Developer Preview](https://developers.google.com/workspace/preview): Creates a section in Google Chat. Sections help users group conversations and customize the list of spaces displayed in Chat navigation panel. Only sections of type `CUSTOM_SECTION` can be created. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`

+

Creates a section in Google Chat. Sections help users group conversations and customize the list of spaces displayed in Chat navigation panel. Only sections of type `CUSTOM_SECTION` can be created. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`

delete(name, x__xgafv=None)

-

[Developer Preview](https://developers.google.com/workspace/preview): Deletes a section of type `CUSTOM_SECTION`. If the section contains items, such as spaces, the items are moved to Google Chat's default sections and are not deleted. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`

+

Deletes a section of type `CUSTOM_SECTION`. If the section contains items, such as spaces, the items are moved to Google Chat's default sections and are not deleted. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`

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

-

[Developer Preview](https://developers.google.com/workspace/preview): Lists sections available to the Chat user. Sections help users group their conversations and customize the list of spaces displayed in Chat navigation panel. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`

+

Lists sections available to the Chat user. Sections help users group their conversations and customize the list of spaces displayed in Chat navigation panel. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`

list_next()

Retrieves the next page of results.

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

-

[Developer Preview](https://developers.google.com/workspace/preview): Updates a section. Only sections of type `CUSTOM_SECTION` can be updated. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`

+

Updates a section. Only sections of type `CUSTOM_SECTION` can be updated. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`

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

-

[Developer Preview](https://developers.google.com/workspace/preview): Changes the sort order of a section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`

+

Changes the sort order of a section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`

Method Details

close() @@ -108,14 +108,14 @@

Method Details

create(parent, body=None, x__xgafv=None) -
[Developer Preview](https://developers.google.com/workspace/preview): Creates a section in Google Chat. Sections help users group conversations and customize the list of spaces displayed in Chat navigation panel. Only sections of type `CUSTOM_SECTION` can be created. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`
+  
Creates a section in Google Chat. Sections help users group conversations and customize the list of spaces displayed in Chat navigation panel. Only sections of type `CUSTOM_SECTION` can be created. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`
 
 Args:
   parent: string, Required. The parent resource name where the section is created. Format: `users/{user}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`. [Developer Preview](https://developers.google.com/workspace/preview).
+{ # Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`.
   "displayName": "A String", # Optional. The section's display name. Only populated for sections of type `CUSTOM_SECTION`. Supports up to 80 characters. Required when creating a `CUSTOM_SECTION`.
   "name": "A String", # Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}`
   "sortOrder": 42, # Output only. The order of the section in relation to other sections. Sections with a lower `sort_order` value appear before sections with a higher value.
@@ -130,7 +130,7 @@ 

Method Details

Returns: An object of the form: - { # Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`. [Developer Preview](https://developers.google.com/workspace/preview). + { # Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`. "displayName": "A String", # Optional. The section's display name. Only populated for sections of type `CUSTOM_SECTION`. Supports up to 80 characters. Required when creating a `CUSTOM_SECTION`. "name": "A String", # Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}` "sortOrder": 42, # Output only. The order of the section in relation to other sections. Sections with a lower `sort_order` value appear before sections with a higher value. @@ -140,7 +140,7 @@

Method Details

delete(name, x__xgafv=None) -
[Developer Preview](https://developers.google.com/workspace/preview): Deletes a section of type `CUSTOM_SECTION`. If the section contains items, such as spaces, the items are moved to Google Chat's default sections and are not deleted. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`
+  
Deletes a section of type `CUSTOM_SECTION`. If the section contains items, such as spaces, the items are moved to Google Chat's default sections and are not deleted. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`
 
 Args:
   name: string, Required. The name of the section to delete. Format: `users/{user}/sections/{section}` (required)
@@ -158,7 +158,7 @@ 

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
[Developer Preview](https://developers.google.com/workspace/preview): Lists sections available to the Chat user. Sections help users group their conversations and customize the list of spaces displayed in Chat navigation panel. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`
+  
Lists sections available to the Chat user. Sections help users group their conversations and customize the list of spaces displayed in Chat navigation panel. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`
 
 Args:
   parent: string, Required. The parent, which is the user resource name that owns this collection of sections. Only supports listing sections for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me`. - Their Workspace email address. For example, `users/user@example.com`. - Their user id. For example, `users/123456789`. Format: `users/{user}` (required)
@@ -172,10 +172,10 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing sections. [Developer Preview](https://developers.google.com/workspace/preview). + { # Response message for listing sections. "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. "sections": [ # The sections from the specified user. - { # Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`. [Developer Preview](https://developers.google.com/workspace/preview). + { # Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`. "displayName": "A String", # Optional. The section's display name. Only populated for sections of type `CUSTOM_SECTION`. Supports up to 80 characters. Required when creating a `CUSTOM_SECTION`. "name": "A String", # Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}` "sortOrder": 42, # Output only. The order of the section in relation to other sections. Sections with a lower `sort_order` value appear before sections with a higher value. @@ -201,14 +201,14 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
[Developer Preview](https://developers.google.com/workspace/preview): Updates a section. Only sections of type `CUSTOM_SECTION` can be updated. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`
+  
Updates a section. Only sections of type `CUSTOM_SECTION` can be updated. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`
 
 Args:
   name: string, Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`. [Developer Preview](https://developers.google.com/workspace/preview).
+{ # Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`.
   "displayName": "A String", # Optional. The section's display name. Only populated for sections of type `CUSTOM_SECTION`. Supports up to 80 characters. Required when creating a `CUSTOM_SECTION`.
   "name": "A String", # Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}`
   "sortOrder": 42, # Output only. The order of the section in relation to other sections. Sections with a lower `sort_order` value appear before sections with a higher value.
@@ -224,7 +224,7 @@ 

Method Details

Returns: An object of the form: - { # Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`. [Developer Preview](https://developers.google.com/workspace/preview). + { # Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`. "displayName": "A String", # Optional. The section's display name. Only populated for sections of type `CUSTOM_SECTION`. Supports up to 80 characters. Required when creating a `CUSTOM_SECTION`. "name": "A String", # Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}` "sortOrder": 42, # Output only. The order of the section in relation to other sections. Sections with a lower `sort_order` value appear before sections with a higher value. @@ -234,14 +234,14 @@

Method Details

position(name, body=None, x__xgafv=None) -
[Developer Preview](https://developers.google.com/workspace/preview): Changes the sort order of a section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`
+  
Changes the sort order of a section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`
 
 Args:
   name: string, Required. The resource name of the section to position. Format: `users/{user}/sections/{section}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for positioning a section. [Developer Preview](https://developers.google.com/workspace/preview).
+{ # Request message for positioning a section.
   "relativePosition": "A String", # Optional. The relative position of the section in the list of sections.
   "sortOrder": 42, # Optional. The absolute position of the section in the list of sections. The position must be greater than 0. If the position is greater than the number of sections, the section will be appended to the end of the list. This operation inserts the section at the given position and shifts the original section at that position, and those below it, to the next position.
 }
@@ -254,8 +254,8 @@ 

Method Details

Returns: An object of the form: - { # Response message for positioning a section. [Developer Preview](https://developers.google.com/workspace/preview). - "section": { # Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`. [Developer Preview](https://developers.google.com/workspace/preview). # The updated section. + { # Response message for positioning a section. + "section": { # Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`. # The updated section. "displayName": "A String", # Optional. The section's display name. Only populated for sections of type `CUSTOM_SECTION`. Supports up to 80 characters. Required when creating a `CUSTOM_SECTION`. "name": "A String", # Identifier. Resource name of the section. For system sections, the section ID is a constant string: - DEFAULT_DIRECT_MESSAGES: `users/{user}/sections/default-direct-messages` - DEFAULT_SPACES: `users/{user}/sections/default-spaces` - DEFAULT_APPS: `users/{user}/sections/default-apps` Format: `users/{user}/sections/{section}` "sortOrder": 42, # Output only. The order of the section in relation to other sections. Sections with a lower `sort_order` value appear before sections with a higher value. diff --git a/docs/dyn/chat_v1.users.sections.items.html b/docs/dyn/chat_v1.users.sections.items.html index a17017ca4c..1542886c27 100644 --- a/docs/dyn/chat_v1.users.sections.items.html +++ b/docs/dyn/chat_v1.users.sections.items.html @@ -79,13 +79,13 @@

Instance Methods

Close httplib2 connections.

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

-

[Developer Preview](https://developers.google.com/workspace/preview): Lists items in a section. Only spaces can be section items. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`

+

Lists items in a section. Only spaces can be section items. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`

list_next()

Retrieves the next page of results.

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

-

[Developer Preview](https://developers.google.com/workspace/preview): Moves an item from one section to another. For example, if a section contains spaces, this method can be used to move a space to a different section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`

+

Moves an item from one section to another. For example, if a section contains spaces, this method can be used to move a space to a different section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`

Method Details

close() @@ -94,7 +94,7 @@

Method Details

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
[Developer Preview](https://developers.google.com/workspace/preview): Lists items in a section. Only spaces can be section items. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`
+  
Lists items in a section. Only spaces can be section items. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`
 
 Args:
   parent: string, Required. The parent, which is the section resource name that owns this collection of section items. Only supports listing section items for the calling user. When you're filtering by space, use the wildcard `-` to search across all sections. For example, `users/{user}/sections/-`. Format: `users/{user}/sections/{section}` (required)
@@ -109,10 +109,10 @@ 

Method Details

Returns: An object of the form: - { # Response message for listing section items. [Developer Preview](https://developers.google.com/workspace/preview). + { # Response message for listing section items. "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. "sectionItems": [ # The section items from the specified section. - { # A user's defined section item. This is used to represent section items, such as spaces, grouped under a section. [Developer Preview](https://developers.google.com/workspace/preview). + { # A user's defined section item. This is used to represent section items, such as spaces, grouped under a section. "name": "A String", # Identifier. The resource name of the section item. Format: `users/{user}/sections/{section}/items/{item}` "space": "A String", # Optional. The space resource name. Format: `spaces/{space}` }, @@ -136,14 +136,14 @@

Method Details

move(name, body=None, x__xgafv=None) -
[Developer Preview](https://developers.google.com/workspace/preview): Moves an item from one section to another. For example, if a section contains spaces, this method can be used to move a space to a different section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`
+  
Moves an item from one section to another. For example, if a section contains spaces, this method can be used to move a space to a different section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`
 
 Args:
   name: string, Required. The resource name of the section item to move. Format: `users/{user}/sections/{section}/items/{item}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Request message for moving a section item across sections. [Developer Preview](https://developers.google.com/workspace/preview).
+{ # Request message for moving a section item across sections.
   "targetSection": "A String", # Required. The resource name of the section to move the section item to. Format: `users/{user}/sections/{section}`
 }
 
@@ -155,8 +155,8 @@ 

Method Details

Returns: An object of the form: - { # Response message for moving a section item. [Developer Preview](https://developers.google.com/workspace/preview). - "sectionItem": { # A user's defined section item. This is used to represent section items, such as spaces, grouped under a section. [Developer Preview](https://developers.google.com/workspace/preview). # The updated section item. + { # Response message for moving a section item. + "sectionItem": { # A user's defined section item. This is used to represent section items, such as spaces, grouped under a section. # The updated section item. "name": "A String", # Identifier. The resource name of the section item. Format: `users/{user}/sections/{section}/items/{item}` "space": "A String", # Optional. The space resource name. Format: `spaces/{space}` }, diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index d170a768f1..388224c597 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -503,6 +503,55 @@ "https://www.googleapis.com/auth/chat.spaces.readonly" ] }, +"findGroupChats": { +"description": "[Developer Preview](https://developers.google.com/workspace/preview): Returns all spaces with `spaceType == GROUP_CHAT`, whose human memberships contain exactly the calling user, and the users specified in `FindGroupChatsRequest.users`. Only members that have joined the conversation are supported. For an example, see [Find group chats](https://developers.google.com/workspace/chat/find-group-chats). If the calling user blocks, or is blocked by, some users, and no spaces with the entire specified set of users are found, this method returns spaces that don't include the blocked or blocking users. The specified set of users must contain only human (non-app) memberships. A request that contains non-human users doesn't return any spaces. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships`", +"flatPath": "v1/spaces:findGroupChats", +"httpMethod": "GET", +"id": "chat.spaces.findGroupChats", +"parameterOrder": [], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 10 spaces are returned. The maximum value is 30. If you use a value more than 30, it's automatically changed to 30. Negative values return an `INVALID_ARGUMENT` error.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous call to find group chats. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the token. Passing different values may lead to unexpected results.", +"location": "query", +"type": "string" +}, +"spaceView": { +"description": "Requested space view type. If unset, defaults to `SPACE_VIEW_RESOURCE_NAME_ONLY`. Requests that specify `SPACE_VIEW_EXPANDED` must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly.", +"enum": [ +"SPACE_VIEW_UNSPECIFIED", +"SPACE_VIEW_RESOURCE_NAME_ONLY", +"SPACE_VIEW_EXPANDED" +], +"enumDescriptions": [ +"The default / unset value.", +"Populates only the Space resource name.", +"Populates Space resource fields. Note: the `permissionSettings` field will not be populated. Requests that specify SPACE_VIEW_EXPANDED must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly." +], +"location": "query", +"type": "string" +}, +"users": { +"description": "Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request. The maximum number of users that can be specified in a single request is `49`. Format: `users/{user}`, where `{user}` is either the `id` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, to find all group chats with the calling user and two other users, with People API profile IDs `123456789` and `987654321`, you can use `users/123456789` and `users/987654321`. You can also use the email as an alias for `{user}`. For example, `users/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.", +"location": "query", +"repeated": true, +"type": "string" +} +}, +"path": "v1/spaces:findGroupChats", +"response": { +"$ref": "FindGroupChatsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/chat.memberships", +"https://www.googleapis.com/auth/chat.memberships.readonly" +] +}, "get": { "description": "Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.spaces` with [administrator approval](https://support.google.com/a?p=chat-app-auth) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.spaces.readonly` - `https://www.googleapis.com/auth/chat.admin.spaces` App authentication has the following limitations: - `space.access_settings` is only populated when using the `chat.app.spaces` scope. - `space.predefind_permission_settings` and `space.permission_settings` are only populated when using the `chat.app.spaces` scope, and only for spaces the app created.", "flatPath": "v1/spaces/{spacesId}", @@ -991,7 +1040,7 @@ ] }, "get": { -"description": "Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot`: When using this authorization scope, this method returns details about a message the Chat app has access to, like direct messages and [slash commands](https://developers.google.com/workspace/chat/slash-commands) that invoke the Chat app. - `https://www.googleapis.com/auth/chat.app.messages.readonly` with [administrator approval](https://support.google.com/a?p=chat-app-auth) (available in [Developer Preview](https://developers.google.com/workspace/preview)). When using this authentication scope, this method returns details about a public message in a space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` Note: Might return a message from a blocked member or space.", +"description": "Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot`: When using this authorization scope, this method returns details about a message the Chat app has access to, like direct messages and [slash commands](https://developers.google.com/workspace/chat/slash-commands) that invoke the Chat app. - `https://www.googleapis.com/auth/chat.app.messages.readonly` with [administrator approval](https://support.google.com/a?p=chat-app-auth). When using this authentication scope, this method returns details about a public message in a space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` Note: Might return a message from a blocked member or space.", "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}", "httpMethod": "GET", "id": "chat.spaces.messages.get", @@ -1019,7 +1068,7 @@ ] }, "list": { -"description": "Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. System messages, like those announcing new space members, aren't included. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, `{}`. For an example, see [List messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) with the authorization scope: - `https://www.googleapis.com/auth/chat.app.messages.readonly`. When using this authentication scope, this method only returns public messages in a space. It doesn't include private messages. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)", +"description": "Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. System messages, like those announcing new space members, aren't included. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, `{}`. For an example, see [List messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/list). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the authorization scope: - `https://www.googleapis.com/auth/chat.app.messages.readonly`. When using this authentication scope, this method only returns public messages in a space. It doesn't include private messages. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)", "flatPath": "v1/spaces/{spacesId}/messages", "httpMethod": "GET", "id": "chat.spaces.messages.list", @@ -1296,7 +1345,7 @@ "spaceEvents": { "methods": { "get": { -"description": "Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated caller must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).", +"description": "Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Note: The `permissionSettings` field is not returned in the Space object of the Space event data for this request. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.spaces.readonly` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - `https://www.googleapis.com/auth/chat.app.memberships.readonly` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To get an event, the authenticated caller must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).", "flatPath": "v1/spaces/{spacesId}/spaceEvents/{spaceEventsId}", "httpMethod": "GET", "id": "chat.spaces.spaceEvents.get", @@ -1333,7 +1382,7 @@ ] }, "list": { -"description": "Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) in [Developer Preview](https://developers.google.com/workspace/preview) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated caller must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).", +"description": "Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize) with an [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes) appropriate for reading the requested data: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.app.spaces` - `https://www.googleapis.com/auth/chat.app.spaces.readonly` - `https://www.googleapis.com/auth/chat.app.messages.readonly` - `https://www.googleapis.com/auth/chat.app.memberships` - `https://www.googleapis.com/auth/chat.app.memberships.readonly` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces` - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.messages.reactions.readonly` - `https://www.googleapis.com/auth/chat.messages.reactions` - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` To list events, the authenticated caller must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).", "flatPath": "v1/spaces/{spacesId}/spaceEvents", "httpMethod": "GET", "id": "chat.spaces.spaceEvents.list", @@ -1394,7 +1443,7 @@ "sections": { "methods": { "create": { -"description": "[Developer Preview](https://developers.google.com/workspace/preview): Creates a section in Google Chat. Sections help users group conversations and customize the list of spaces displayed in Chat navigation panel. Only sections of type `CUSTOM_SECTION` can be created. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`", +"description": "Creates a section in Google Chat. Sections help users group conversations and customize the list of spaces displayed in Chat navigation panel. Only sections of type `CUSTOM_SECTION` can be created. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`", "flatPath": "v1/users/{usersId}/sections", "httpMethod": "POST", "id": "chat.users.sections.create", @@ -1422,7 +1471,7 @@ ] }, "delete": { -"description": "[Developer Preview](https://developers.google.com/workspace/preview): Deletes a section of type `CUSTOM_SECTION`. If the section contains items, such as spaces, the items are moved to Google Chat's default sections and are not deleted. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`", +"description": "Deletes a section of type `CUSTOM_SECTION`. If the section contains items, such as spaces, the items are moved to Google Chat's default sections and are not deleted. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`", "flatPath": "v1/users/{usersId}/sections/{sectionsId}", "httpMethod": "DELETE", "id": "chat.users.sections.delete", @@ -1447,7 +1496,7 @@ ] }, "list": { -"description": "[Developer Preview](https://developers.google.com/workspace/preview): Lists sections available to the Chat user. Sections help users group their conversations and customize the list of spaces displayed in Chat navigation panel. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`", +"description": "Lists sections available to the Chat user. Sections help users group their conversations and customize the list of spaces displayed in Chat navigation panel. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`", "flatPath": "v1/users/{usersId}/sections", "httpMethod": "GET", "id": "chat.users.sections.list", @@ -1484,7 +1533,7 @@ ] }, "patch": { -"description": "[Developer Preview](https://developers.google.com/workspace/preview): Updates a section. Only sections of type `CUSTOM_SECTION` can be updated. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`", +"description": "Updates a section. Only sections of type `CUSTOM_SECTION` can be updated. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`", "flatPath": "v1/users/{usersId}/sections/{sectionsId}", "httpMethod": "PATCH", "id": "chat.users.sections.patch", @@ -1518,7 +1567,7 @@ ] }, "position": { -"description": "[Developer Preview](https://developers.google.com/workspace/preview): Changes the sort order of a section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`", +"description": "Changes the sort order of a section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`", "flatPath": "v1/users/{usersId}/sections/{sectionsId}:position", "httpMethod": "POST", "id": "chat.users.sections.position", @@ -1550,7 +1599,7 @@ "items": { "methods": { "list": { -"description": "[Developer Preview](https://developers.google.com/workspace/preview): Lists items in a section. Only spaces can be section items. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`", +"description": "Lists items in a section. Only spaces can be section items. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections` - `https://www.googleapis.com/auth/chat.users.sections.readonly`", "flatPath": "v1/users/{usersId}/sections/{sectionsId}/items", "httpMethod": "GET", "id": "chat.users.sections.items.list", @@ -1592,7 +1641,7 @@ ] }, "move": { -"description": "[Developer Preview](https://developers.google.com/workspace/preview): Moves an item from one section to another. For example, if a section contains spaces, this method can be used to move a space to a different section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`", +"description": "Moves an item from one section to another. For example, if a section contains spaces, this method can be used to move a space to a different section. For details, see [Create and organize sections in Google Chat](https://support.google.com/chat/answer/16059854). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.sections`", "flatPath": "v1/users/{usersId}/sections/{sectionsId}/items/{itemsId}:move", "httpMethod": "POST", "id": "chat.users.sections.items.move", @@ -1785,7 +1834,7 @@ } } }, -"revision": "20260327", +"revision": "20260405", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -2690,6 +2739,24 @@ "properties": {}, "type": "object" }, +"FindGroupChatsResponse": { +"description": "A response containing group chat spaces with exactly the calling user and the requested users. [Developer Preview](https://developers.google.com/workspace/preview):", +"id": "FindGroupChatsResponse", +"properties": { +"nextPageToken": { +"description": "A token that you can send as `pageToken` to retrieve the next page of results. If empty, there are no subsequent pages.", +"type": "string" +}, +"spaces": { +"description": "List of spaces in the requested (or first) page.", +"items": { +"$ref": "Space" +}, +"type": "array" +} +}, +"type": "object" +}, "FormAction": { "description": "A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form.", "id": "FormAction", @@ -4300,7 +4367,7 @@ "type": "object" }, "GoogleChatV1Section": { -"description": "Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`. [Developer Preview](https://developers.google.com/workspace/preview).", +"description": "Represents a [section](https://support.google.com/chat/answer/16059854) in Google Chat. Sections help users organize their spaces. There are two types of sections: 1. **System Sections:** These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their `display_name` modified. Examples include: * `users/{user}/sections/default-direct-messages` * `users/{user}/sections/default-spaces` * `users/{user}/sections/default-apps` 2. **Custom Sections:** These are sections created and managed by the user. Creating a custom section using `CreateSection` **requires** a `display_name`. Custom sections can be updated using `UpdateSection` and deleted using `DeleteSection`.", "id": "GoogleChatV1Section", "properties": { "displayName": { @@ -4673,7 +4740,7 @@ "type": "object" }, "ListSectionItemsResponse": { -"description": "Response message for listing section items. [Developer Preview](https://developers.google.com/workspace/preview).", +"description": "Response message for listing section items.", "id": "ListSectionItemsResponse", "properties": { "nextPageToken": { @@ -4691,7 +4758,7 @@ "type": "object" }, "ListSectionsResponse": { -"description": "Response message for listing sections. [Developer Preview](https://developers.google.com/workspace/preview).", +"description": "Response message for listing sections.", "id": "ListSectionsResponse", "properties": { "nextPageToken": { @@ -5190,7 +5257,7 @@ "type": "object" }, "MoveSectionItemRequest": { -"description": "Request message for moving a section item across sections. [Developer Preview](https://developers.google.com/workspace/preview).", +"description": "Request message for moving a section item across sections.", "id": "MoveSectionItemRequest", "properties": { "targetSection": { @@ -5201,7 +5268,7 @@ "type": "object" }, "MoveSectionItemResponse": { -"description": "Response message for moving a section item. [Developer Preview](https://developers.google.com/workspace/preview).", +"description": "Response message for moving a section item.", "id": "MoveSectionItemResponse", "properties": { "sectionItem": { @@ -5297,7 +5364,7 @@ "type": "object" }, "PositionSectionRequest": { -"description": "Request message for positioning a section. [Developer Preview](https://developers.google.com/workspace/preview).", +"description": "Request message for positioning a section.", "id": "PositionSectionRequest", "properties": { "relativePosition": { @@ -5323,7 +5390,7 @@ "type": "object" }, "PositionSectionResponse": { -"description": "Response message for positioning a section. [Developer Preview](https://developers.google.com/workspace/preview).", +"description": "Response message for positioning a section.", "id": "PositionSectionResponse", "properties": { "section": { @@ -5568,7 +5635,7 @@ "type": "object" }, "SectionItem": { -"description": "A user's defined section item. This is used to represent section items, such as spaces, grouped under a section. [Developer Preview](https://developers.google.com/workspace/preview).", +"description": "A user's defined section item. This is used to represent section items, such as spaces, grouped under a section.", "id": "SectionItem", "properties": { "name": { From 7c6b6ff5148666baf95c2a0a0c20e326d4ecf786 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:40:58 +0000 Subject: [PATCH 07/32] feat(cloudsupport): update the api #### cloudsupport:v2 The following keys were added: - schemas.ContentTypeInfo.properties.fromFusionId.type (Total Keys: 1) - schemas.ContentTypeInfo.properties.fusionIdDetectionMetadata (Total Keys: 2) #### cloudsupport:v2beta The following keys were added: - schemas.ContentTypeInfo.properties.fromFusionId.type (Total Keys: 1) - schemas.ContentTypeInfo.properties.fusionIdDetectionMetadata (Total Keys: 2) --- docs/dyn/cloudsupport_v2.cases.html | 2 +- docs/dyn/cloudsupport_v2.media.html | 2 ++ docs/dyn/cloudsupport_v2beta.cases.html | 2 +- docs/dyn/cloudsupport_v2beta.media.html | 2 ++ .../discovery_cache/documents/cloudsupport.v2.json | 13 +++++++++++-- .../documents/cloudsupport.v2beta.json | 13 +++++++++++-- 6 files changed, 28 insertions(+), 6 deletions(-) diff --git a/docs/dyn/cloudsupport_v2.cases.html b/docs/dyn/cloudsupport_v2.cases.html index 8a99c6c010..775cbaebfc 100644 --- a/docs/dyn/cloudsupport_v2.cases.html +++ b/docs/dyn/cloudsupport_v2.cases.html @@ -479,7 +479,7 @@

Method Details

parent: string, The name of the parent resource to search for cases under. (required) pageSize: integer, The maximum number of cases fetched with each request. The default page size is 10. pageToken: string, A token identifying the page of results to return. If unspecified, the first page is retrieved. - query: string, An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. You must specify either `organization` or `project`. To search across `displayName`, `description`, and comments, use a global restriction with no keyword or operator. For example, `"my search"`. To search only cases updated after a certain date, use `update_time` restricted with that particular date, time, and timezone in ISO datetime format. For example, `update_time>"2020-01-01T00:00:00-05:00"`. `update_time` only supports the greater than operator (`>`). Examples: - `organization="organizations/123456789"` - `project="projects/my-project-id"` - `project="projects/123456789"` - `organization="organizations/123456789" AND state=CLOSED` - `project="projects/my-project-id" AND creator.email="tester@example.com"` - `project="projects/my-project-id" AND (priority=P0 OR priority=P1)` + query: string, An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. To search across `displayName`, `description`, and comments, use a global restriction with no keyword or operator. For example, `"my search"`. To search only cases updated after a certain date, use `update_time` restricted with that particular date, time, and timezone in ISO datetime format. For example, `update_time>"2020-01-01T00:00:00-05:00"`. `update_time` only supports the greater than operator (`>`). If you are using the `v2` version of the API, you must specify the case parent in the `parent` field. If you provide an empty `query`, all cases under the parent resource will be returned. If you are using the `v2beta` version of the API, you must specify the case parent in the `query` field using one of the two fields below, which are only available for `v2beta`. The `parent` field will be ignored. - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. Examples: For `v2`: - `state=CLOSED` - `state=OPEN AND creator.email="tester@example.com"` - `state=OPEN AND (priority=P0 OR priority=P1)` - `update_time>"2020-01-01T00:00:00-05:00"` For `v2beta`: - `organization="organizations/123456789"` - `project="projects/my-project-id"` - `project="projects/123456789"` - `organization="organizations/123456789" AND state=CLOSED` - `project="projects/my-project-id" AND creator.email="tester@example.com"` - `project="projects/my-project-id" AND (priority=P0 OR priority=P1)` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/cloudsupport_v2.media.html b/docs/dyn/cloudsupport_v2.media.html index a4b0a4df8c..89b422bf83 100644 --- a/docs/dyn/cloudsupport_v2.media.html +++ b/docs/dyn/cloudsupport_v2.media.html @@ -151,8 +151,10 @@

Method Details

"bestGuess": "A String", # # gdata.* are outside protos with mising documentation "fromBytes": "A String", # # gdata.* are outside protos with mising documentation "fromFileName": "A String", # # gdata.* are outside protos with mising documentation + "fromFusionId": "A String", # # gdata.* are outside protos with mising documentation "fromHeader": "A String", # # gdata.* are outside protos with mising documentation "fromUrlPath": "A String", # # gdata.* are outside protos with mising documentation + "fusionIdDetectionMetadata": "A String", # # gdata.* are outside protos with mising documentation }, "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation "crc32cHash": 42, # # gdata.* are outside protos with mising documentation diff --git a/docs/dyn/cloudsupport_v2beta.cases.html b/docs/dyn/cloudsupport_v2beta.cases.html index 730e148766..5e0b02c8f7 100644 --- a/docs/dyn/cloudsupport_v2beta.cases.html +++ b/docs/dyn/cloudsupport_v2beta.cases.html @@ -522,7 +522,7 @@

Method Details

pageSize: integer, The maximum number of cases fetched with each request. The default page size is 10. pageToken: string, A token identifying the page of results to return. If unspecified, the first page is retrieved. parent: string, The name of the parent resource to search for cases under. - query: string, An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. You must specify either `organization` or `project`. To search across `displayName`, `description`, and comments, use a global restriction with no keyword or operator. For example, `"my search"`. To search only cases updated after a certain date, use `update_time` restricted with that particular date, time, and timezone in ISO datetime format. For example, `update_time>"2020-01-01T00:00:00-05:00"`. `update_time` only supports the greater than operator (`>`). Examples: - `organization="organizations/123456789"` - `project="projects/my-project-id"` - `project="projects/123456789"` - `organization="organizations/123456789" AND state=CLOSED` - `project="projects/my-project-id" AND creator.email="tester@example.com"` - `project="projects/my-project-id" AND (priority=P0 OR priority=P1)` + query: string, An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. To search across `displayName`, `description`, and comments, use a global restriction with no keyword or operator. For example, `"my search"`. To search only cases updated after a certain date, use `update_time` restricted with that particular date, time, and timezone in ISO datetime format. For example, `update_time>"2020-01-01T00:00:00-05:00"`. `update_time` only supports the greater than operator (`>`). If you are using the `v2` version of the API, you must specify the case parent in the `parent` field. If you provide an empty `query`, all cases under the parent resource will be returned. If you are using the `v2beta` version of the API, you must specify the case parent in the `query` field using one of the two fields below, which are only available for `v2beta`. The `parent` field will be ignored. - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. Examples: For `v2`: - `state=CLOSED` - `state=OPEN AND creator.email="tester@example.com"` - `state=OPEN AND (priority=P0 OR priority=P1)` - `update_time>"2020-01-01T00:00:00-05:00"` For `v2beta`: - `organization="organizations/123456789"` - `project="projects/my-project-id"` - `project="projects/123456789"` - `organization="organizations/123456789" AND state=CLOSED` - `project="projects/my-project-id" AND creator.email="tester@example.com"` - `project="projects/my-project-id" AND (priority=P0 OR priority=P1)` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/cloudsupport_v2beta.media.html b/docs/dyn/cloudsupport_v2beta.media.html index 3b85587204..f6f9d11636 100644 --- a/docs/dyn/cloudsupport_v2beta.media.html +++ b/docs/dyn/cloudsupport_v2beta.media.html @@ -151,8 +151,10 @@

Method Details

"bestGuess": "A String", # # gdata.* are outside protos with mising documentation "fromBytes": "A String", # # gdata.* are outside protos with mising documentation "fromFileName": "A String", # # gdata.* are outside protos with mising documentation + "fromFusionId": "A String", # # gdata.* are outside protos with mising documentation "fromHeader": "A String", # # gdata.* are outside protos with mising documentation "fromUrlPath": "A String", # # gdata.* are outside protos with mising documentation + "fusionIdDetectionMetadata": "A String", # # gdata.* are outside protos with mising documentation }, "cosmoBinaryReference": "A String", # # gdata.* are outside protos with mising documentation "crc32cHash": 42, # # gdata.* are outside protos with mising documentation diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json index e4e3bed110..db0e3f4852 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json @@ -355,7 +355,7 @@ "type": "string" }, "query": { -"description": "An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. You must specify either `organization` or `project`. To search across `displayName`, `description`, and comments, use a global restriction with no keyword or operator. For example, `\"my search\"`. To search only cases updated after a certain date, use `update_time` restricted with that particular date, time, and timezone in ISO datetime format. For example, `update_time>\"2020-01-01T00:00:00-05:00\"`. `update_time` only supports the greater than operator (`>`). Examples: - `organization=\"organizations/123456789\"` - `project=\"projects/my-project-id\"` - `project=\"projects/123456789\"` - `organization=\"organizations/123456789\" AND state=CLOSED` - `project=\"projects/my-project-id\" AND creator.email=\"tester@example.com\"` - `project=\"projects/my-project-id\" AND (priority=P0 OR priority=P1)`", +"description": "An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. To search across `displayName`, `description`, and comments, use a global restriction with no keyword or operator. For example, `\"my search\"`. To search only cases updated after a certain date, use `update_time` restricted with that particular date, time, and timezone in ISO datetime format. For example, `update_time>\"2020-01-01T00:00:00-05:00\"`. `update_time` only supports the greater than operator (`>`). If you are using the `v2` version of the API, you must specify the case parent in the `parent` field. If you provide an empty `query`, all cases under the parent resource will be returned. If you are using the `v2beta` version of the API, you must specify the case parent in the `query` field using one of the two fields below, which are only available for `v2beta`. The `parent` field will be ignored. - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. Examples: For `v2`: - `state=CLOSED` - `state=OPEN AND creator.email=\"tester@example.com\"` - `state=OPEN AND (priority=P0 OR priority=P1)` - `update_time>\"2020-01-01T00:00:00-05:00\"` For `v2beta`: - `organization=\"organizations/123456789\"` - `project=\"projects/my-project-id\"` - `project=\"projects/123456789\"` - `organization=\"organizations/123456789\" AND state=CLOSED` - `project=\"projects/my-project-id\" AND creator.email=\"tester@example.com\"` - `project=\"projects/my-project-id\" AND (priority=P0 OR priority=P1)`", "location": "query", "type": "string" } @@ -552,7 +552,7 @@ } } }, -"revision": "20260113", +"revision": "20260409", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { @@ -909,6 +909,10 @@ "description": "# gdata.* are outside protos with mising documentation", "type": "string" }, +"fromFusionId": { +"description": "# gdata.* are outside protos with mising documentation", +"type": "string" +}, "fromHeader": { "description": "# gdata.* are outside protos with mising documentation", "type": "string" @@ -916,6 +920,11 @@ "fromUrlPath": { "description": "# gdata.* are outside protos with mising documentation", "type": "string" +}, +"fusionIdDetectionMetadata": { +"description": "# gdata.* are outside protos with mising documentation", +"format": "byte", +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json index d5a81ed8e6..fb24e966e6 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json @@ -381,7 +381,7 @@ "type": "string" }, "query": { -"description": "An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. You must specify either `organization` or `project`. To search across `displayName`, `description`, and comments, use a global restriction with no keyword or operator. For example, `\"my search\"`. To search only cases updated after a certain date, use `update_time` restricted with that particular date, time, and timezone in ISO datetime format. For example, `update_time>\"2020-01-01T00:00:00-05:00\"`. `update_time` only supports the greater than operator (`>`). Examples: - `organization=\"organizations/123456789\"` - `project=\"projects/my-project-id\"` - `project=\"projects/123456789\"` - `organization=\"organizations/123456789\" AND state=CLOSED` - `project=\"projects/my-project-id\" AND creator.email=\"tester@example.com\"` - `project=\"projects/my-project-id\" AND (priority=P0 OR priority=P1)`", +"description": "An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. To search across `displayName`, `description`, and comments, use a global restriction with no keyword or operator. For example, `\"my search\"`. To search only cases updated after a certain date, use `update_time` restricted with that particular date, time, and timezone in ISO datetime format. For example, `update_time>\"2020-01-01T00:00:00-05:00\"`. `update_time` only supports the greater than operator (`>`). If you are using the `v2` version of the API, you must specify the case parent in the `parent` field. If you provide an empty `query`, all cases under the parent resource will be returned. If you are using the `v2beta` version of the API, you must specify the case parent in the `query` field using one of the two fields below, which are only available for `v2beta`. The `parent` field will be ignored. - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. Examples: For `v2`: - `state=CLOSED` - `state=OPEN AND creator.email=\"tester@example.com\"` - `state=OPEN AND (priority=P0 OR priority=P1)` - `update_time>\"2020-01-01T00:00:00-05:00\"` For `v2beta`: - `organization=\"organizations/123456789\"` - `project=\"projects/my-project-id\"` - `project=\"projects/123456789\"` - `organization=\"organizations/123456789\" AND state=CLOSED` - `project=\"projects/my-project-id\" AND creator.email=\"tester@example.com\"` - `project=\"projects/my-project-id\" AND (priority=P0 OR priority=P1)`", "location": "query", "type": "string" } @@ -669,7 +669,7 @@ } } }, -"revision": "20260113", +"revision": "20260409", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { @@ -1050,6 +1050,10 @@ "description": "# gdata.* are outside protos with mising documentation", "type": "string" }, +"fromFusionId": { +"description": "# gdata.* are outside protos with mising documentation", +"type": "string" +}, "fromHeader": { "description": "# gdata.* are outside protos with mising documentation", "type": "string" @@ -1057,6 +1061,11 @@ "fromUrlPath": { "description": "# gdata.* are outside protos with mising documentation", "type": "string" +}, +"fusionIdDetectionMetadata": { +"description": "# gdata.* are outside protos with mising documentation", +"format": "byte", +"type": "string" } }, "type": "object" From db2ecf47d5568ed06d0b5e8eadd2867b0afb4d3f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:40:59 +0000 Subject: [PATCH 08/32] feat(compute): update the api #### compute:v1 The following keys were added: - schemas.CachePolicy (Total Keys: 32) - schemas.HttpRouteAction.properties.cachePolicy.$ref (Total Keys: 1) --- docs/dyn/compute_alpha.regionUrlMaps.html | 3624 +++++----- docs/dyn/compute_alpha.urlMaps.html | 4228 +++++------ docs/dyn/compute_beta.regionUrlMaps.html | 3624 +++++----- docs/dyn/compute_beta.urlMaps.html | 4228 +++++------ docs/dyn/compute_v1.regionUrlMaps.html | 5292 +++++++++++++- docs/dyn/compute_v1.urlMaps.html | 6314 ++++++++++++++++- .../documents/compute.alpha.json | 28 +- .../documents/compute.beta.json | 28 +- .../discovery_cache/documents/compute.v1.json | 132 +- 9 files changed, 19768 insertions(+), 7730 deletions(-) diff --git a/docs/dyn/compute_alpha.regionUrlMaps.html b/docs/dyn/compute_alpha.regionUrlMaps.html index feb8faf8c4..5dc317ad2e 100644 --- a/docs/dyn/compute_alpha.regionUrlMaps.html +++ b/docs/dyn/compute_alpha.regionUrlMaps.html @@ -555,26 +555,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -592,15 +597,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -615,24 +620,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -644,15 +651,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -664,16 +672,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -689,27 +697,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -733,7 +741,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -1403,26 +1412,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -1440,15 +1454,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -1463,24 +1477,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1492,15 +1508,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1512,16 +1529,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1537,27 +1554,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -1581,7 +1598,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -2232,26 +2250,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -2269,15 +2292,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -2292,24 +2315,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -2321,15 +2346,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -2341,16 +2367,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -2366,27 +2392,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -2410,7 +2436,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -3323,26 +3350,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -3360,15 +3392,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -3383,24 +3415,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -3412,15 +3446,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -3432,16 +3467,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -3457,27 +3492,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -3501,7 +3536,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -4177,26 +4213,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -4214,15 +4255,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -4237,24 +4278,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -4266,15 +4309,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -4286,16 +4330,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -4311,27 +4355,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -4355,7 +4399,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -5025,26 +5070,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -5062,15 +5112,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -5085,24 +5135,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5114,15 +5166,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5134,16 +5187,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5159,27 +5212,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -5203,7 +5256,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -5854,26 +5908,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -5891,15 +5950,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -5914,24 +5973,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5943,15 +6004,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5963,16 +6025,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5988,27 +6050,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -6032,7 +6094,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -6945,26 +7008,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -6982,15 +7050,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -7005,24 +7073,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -7034,15 +7104,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -7054,16 +7125,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -7079,27 +7150,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -7123,7 +7194,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -8485,26 +8557,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -8522,15 +8599,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -8545,24 +8622,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -8574,15 +8653,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -8594,16 +8674,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -8619,27 +8699,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -8663,7 +8743,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -9333,26 +9414,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -9370,15 +9456,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -9393,24 +9479,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -9422,15 +9510,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -9442,16 +9531,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -9467,27 +9556,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -9511,7 +9600,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -10162,26 +10252,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -10199,15 +10294,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -10222,24 +10317,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -10251,15 +10348,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -10271,16 +10369,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -10296,27 +10394,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -10340,7 +10438,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -11253,26 +11352,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -11290,15 +11394,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -11313,24 +11417,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -11342,15 +11448,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -11362,16 +11469,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -11387,27 +11494,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -11431,7 +11538,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -12158,26 +12266,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -12195,15 +12308,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -12218,24 +12331,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -12247,15 +12362,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -12267,16 +12383,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -12292,27 +12408,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -12336,7 +12452,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -13006,26 +13123,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -13043,15 +13165,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -13066,24 +13188,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -13095,15 +13219,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -13115,16 +13240,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -13140,27 +13265,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -13184,7 +13309,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -13835,26 +13961,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -13872,15 +14003,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -13895,24 +14026,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -13924,15 +14057,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -13944,16 +14078,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -13969,27 +14103,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -14013,7 +14147,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -14926,26 +15061,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -14963,15 +15103,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -14986,24 +15126,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -15015,15 +15157,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -15035,16 +15178,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -15060,27 +15203,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -15104,7 +15247,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -16089,26 +16233,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -16126,15 +16275,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -16149,24 +16298,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -16178,15 +16329,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -16198,16 +16350,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -16223,27 +16375,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -16267,7 +16419,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -16937,26 +17090,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -16974,15 +17132,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -16997,24 +17155,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -17026,15 +17186,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -17046,16 +17207,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -17071,27 +17232,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -17115,7 +17276,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -17766,26 +17928,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -17803,15 +17970,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -17826,24 +17993,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -17855,15 +18024,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -17875,16 +18045,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -17900,27 +18070,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -17944,7 +18114,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -18857,26 +19028,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -18894,15 +19070,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -18917,24 +19093,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -18946,15 +19124,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -18966,16 +19145,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -18991,27 +19170,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -19035,7 +19214,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -19988,26 +20168,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -20025,15 +20210,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -20048,24 +20233,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -20077,15 +20264,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -20097,16 +20285,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -20122,27 +20310,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -20166,7 +20354,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -20836,26 +21025,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -20873,15 +21067,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -20896,24 +21090,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -20925,15 +21121,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -20945,16 +21142,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -20970,27 +21167,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -21014,7 +21211,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -21665,26 +21863,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -21702,15 +21905,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -21725,24 +21928,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -21754,15 +21959,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -21774,16 +21980,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -21799,27 +22005,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -21843,7 +22049,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -22756,26 +22963,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -22793,15 +23005,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -22816,24 +23028,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -22845,15 +23059,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -22865,16 +23080,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -22890,27 +23105,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -22934,7 +23149,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. diff --git a/docs/dyn/compute_alpha.urlMaps.html b/docs/dyn/compute_alpha.urlMaps.html index bf9616a963..730d3b4b3d 100644 --- a/docs/dyn/compute_alpha.urlMaps.html +++ b/docs/dyn/compute_alpha.urlMaps.html @@ -372,26 +372,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -409,15 +414,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -432,24 +437,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -461,15 +468,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -481,16 +489,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -506,27 +514,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -550,7 +558,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -1220,26 +1229,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -1257,15 +1271,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -1280,24 +1294,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1309,15 +1325,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1329,16 +1346,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1354,27 +1371,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -1398,7 +1415,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -2049,26 +2067,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -2086,15 +2109,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -2109,24 +2132,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -2138,15 +2163,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -2158,16 +2184,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -2183,27 +2209,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -2227,7 +2253,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -3140,26 +3167,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -3177,15 +3209,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -3200,24 +3232,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -3229,15 +3263,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -3249,16 +3284,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -3274,27 +3309,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -3318,7 +3353,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -4375,26 +4411,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -4412,15 +4453,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -4435,24 +4476,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -4464,15 +4507,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -4484,16 +4528,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -4509,27 +4553,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -4553,7 +4597,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -5223,26 +5268,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -5260,15 +5310,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -5283,24 +5333,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5312,15 +5364,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5332,16 +5385,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5357,27 +5410,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -5401,7 +5454,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -6052,26 +6106,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -6089,15 +6148,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -6112,24 +6171,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -6141,15 +6202,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -6161,16 +6223,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -6186,27 +6248,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -6230,7 +6292,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -7143,26 +7206,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -7180,15 +7248,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -7203,24 +7271,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -7232,15 +7302,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -7252,16 +7323,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -7277,27 +7348,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -7321,7 +7392,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -7996,26 +8068,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -8033,15 +8110,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -8056,24 +8133,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -8085,15 +8164,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -8105,16 +8185,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -8130,27 +8210,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -8174,7 +8254,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -8844,26 +8925,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -8881,15 +8967,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -8904,24 +8990,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -8933,15 +9021,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -8953,16 +9042,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -8978,27 +9067,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -9022,7 +9111,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -9673,26 +9763,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -9710,15 +9805,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -9733,24 +9828,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -9762,15 +9859,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -9782,16 +9880,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -9807,27 +9905,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -9851,7 +9949,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -10764,26 +10863,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -10801,15 +10905,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -10824,24 +10928,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -10853,15 +10959,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -10873,16 +10980,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -10898,27 +11005,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -10942,7 +11049,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -12324,26 +12432,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -12361,15 +12474,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -12384,24 +12497,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -12413,15 +12528,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -12433,16 +12549,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -12458,27 +12574,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -12502,7 +12618,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -13172,26 +13289,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -13209,15 +13331,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -13232,24 +13354,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -13261,15 +13385,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -13281,16 +13406,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -13306,27 +13431,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -13350,7 +13475,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -14001,26 +14127,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -14038,15 +14169,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -14061,24 +14192,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -14090,15 +14223,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -14110,16 +14244,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -14135,27 +14269,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -14179,7 +14313,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -15092,26 +15227,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -15129,15 +15269,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -15152,24 +15292,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -15181,15 +15323,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -15201,16 +15344,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -15226,27 +15369,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -15270,7 +15413,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -15996,26 +16140,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -16033,15 +16182,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -16056,24 +16205,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -16085,15 +16236,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -16105,16 +16257,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -16130,27 +16282,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -16174,7 +16326,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -16844,26 +16997,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -16881,15 +17039,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -16904,24 +17062,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -16933,15 +17093,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -16953,16 +17114,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -16978,27 +17139,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -17022,7 +17183,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -17673,26 +17835,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -17710,15 +17877,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -17733,24 +17900,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -17762,15 +17931,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -17782,16 +17952,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -17807,27 +17977,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -17851,7 +18021,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -18764,26 +18935,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -18801,15 +18977,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -18824,24 +19000,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -18853,15 +19031,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -18873,16 +19052,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -18898,27 +19077,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -18942,7 +19121,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -19936,26 +20116,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -19973,15 +20158,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -19996,24 +20181,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -20025,15 +20212,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -20045,16 +20233,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -20070,27 +20258,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -20114,7 +20302,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -20784,26 +20973,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -20821,15 +21015,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -20844,24 +21038,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -20873,15 +21069,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -20893,16 +21090,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -20918,27 +21115,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -20962,7 +21159,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -21613,26 +21811,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -21650,15 +21853,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -21673,24 +21876,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -21702,15 +21907,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -21722,16 +21928,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -21747,27 +21953,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -21791,7 +21997,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -22704,26 +22911,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -22741,15 +22953,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -22764,24 +22976,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -22793,15 +23007,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -22813,16 +23028,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -22838,27 +23053,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -22882,7 +23097,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -23862,26 +24078,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -23899,15 +24120,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -23922,24 +24143,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -23951,15 +24174,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -23971,16 +24195,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -23996,27 +24220,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -24040,7 +24264,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -24710,26 +24935,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -24747,15 +24977,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -24770,24 +25000,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -24799,15 +25031,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -24819,16 +25052,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -24844,27 +25077,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -24888,7 +25121,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -25539,26 +25773,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -25576,15 +25815,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -25599,24 +25838,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -25628,15 +25869,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -25648,16 +25890,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -25673,27 +25915,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -25717,7 +25959,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -26630,26 +26873,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -26667,15 +26915,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -26690,24 +26938,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -26719,15 +26969,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -26739,16 +26990,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -26764,27 +27015,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -26808,7 +27059,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. diff --git a/docs/dyn/compute_beta.regionUrlMaps.html b/docs/dyn/compute_beta.regionUrlMaps.html index cc4cb4af7f..b18997d59b 100644 --- a/docs/dyn/compute_beta.regionUrlMaps.html +++ b/docs/dyn/compute_beta.regionUrlMaps.html @@ -554,26 +554,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -591,15 +596,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -614,24 +619,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -643,15 +650,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -663,16 +671,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -688,27 +696,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -732,7 +740,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -1391,26 +1400,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -1428,15 +1442,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -1451,24 +1465,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1480,15 +1496,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1500,16 +1517,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1525,27 +1542,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -1569,7 +1586,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -2209,26 +2227,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -2246,15 +2269,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -2269,24 +2292,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -2298,15 +2323,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -2318,16 +2344,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -2343,27 +2369,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -2387,7 +2413,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -3289,26 +3316,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -3326,15 +3358,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -3349,24 +3381,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -3378,15 +3412,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -3398,16 +3433,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -3423,27 +3458,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -3467,7 +3502,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -4126,26 +4162,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -4163,15 +4204,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -4186,24 +4227,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -4215,15 +4258,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -4235,16 +4279,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -4260,27 +4304,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -4304,7 +4348,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -4963,26 +5008,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -5000,15 +5050,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -5023,24 +5073,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5052,15 +5104,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5072,16 +5125,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5097,27 +5150,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -5141,7 +5194,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -5781,26 +5835,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -5818,15 +5877,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -5841,24 +5900,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5870,15 +5931,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5890,16 +5952,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5915,27 +5977,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -5959,7 +6021,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -6861,26 +6924,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -6898,15 +6966,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -6921,24 +6989,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -6950,15 +7020,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -6970,16 +7041,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -6995,27 +7066,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -7039,7 +7110,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -8371,26 +8443,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -8408,15 +8485,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -8431,24 +8508,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -8460,15 +8539,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -8480,16 +8560,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -8505,27 +8585,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -8549,7 +8629,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -9208,26 +9289,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -9245,15 +9331,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -9268,24 +9354,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -9297,15 +9385,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -9317,16 +9406,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -9342,27 +9431,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -9386,7 +9475,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -10026,26 +10116,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -10063,15 +10158,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -10086,24 +10181,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -10115,15 +10212,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -10135,16 +10233,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -10160,27 +10258,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -10204,7 +10302,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -11106,26 +11205,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -11143,15 +11247,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -11166,24 +11270,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -11195,15 +11301,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -11215,16 +11322,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -11240,27 +11347,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -11284,7 +11391,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -11994,26 +12102,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -12031,15 +12144,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -12054,24 +12167,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -12083,15 +12198,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -12103,16 +12219,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -12128,27 +12244,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -12172,7 +12288,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -12831,26 +12948,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -12868,15 +12990,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -12891,24 +13013,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -12920,15 +13044,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -12940,16 +13065,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -12965,27 +13090,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -13009,7 +13134,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -13649,26 +13775,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -13686,15 +13817,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -13709,24 +13840,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -13738,15 +13871,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -13758,16 +13892,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -13783,27 +13917,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -13827,7 +13961,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -14729,26 +14864,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -14766,15 +14906,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -14789,24 +14929,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -14818,15 +14960,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -14838,16 +14981,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -14863,27 +15006,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -14907,7 +15050,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -15874,26 +16018,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -15911,15 +16060,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -15934,24 +16083,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -15963,15 +16114,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -15983,16 +16135,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -16008,27 +16160,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -16052,7 +16204,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -16711,26 +16864,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -16748,15 +16906,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -16771,24 +16929,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -16800,15 +16960,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -16820,16 +16981,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -16845,27 +17006,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -16889,7 +17050,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -17529,26 +17691,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -17566,15 +17733,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -17589,24 +17756,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -17618,15 +17787,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -17638,16 +17808,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -17663,27 +17833,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -17707,7 +17877,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -18609,26 +18780,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -18646,15 +18822,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -18669,24 +18845,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -18698,15 +18876,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -18718,16 +18897,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -18743,27 +18922,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -18787,7 +18966,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -19722,26 +19902,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -19759,15 +19944,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -19782,24 +19967,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -19811,15 +19998,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -19831,16 +20019,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -19856,27 +20044,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -19900,7 +20088,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -20559,26 +20748,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -20596,15 +20790,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -20619,24 +20813,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -20648,15 +20844,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -20668,16 +20865,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -20693,27 +20890,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -20737,7 +20934,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -21377,26 +21575,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -21414,15 +21617,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -21437,24 +21640,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -21466,15 +21671,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -21486,16 +21692,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -21511,27 +21717,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -21555,7 +21761,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -22457,26 +22664,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -22494,15 +22706,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -22517,24 +22729,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -22546,15 +22760,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -22566,16 +22781,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -22591,27 +22806,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -22635,7 +22850,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. diff --git a/docs/dyn/compute_beta.urlMaps.html b/docs/dyn/compute_beta.urlMaps.html index 6e3553df57..d0a20bb66c 100644 --- a/docs/dyn/compute_beta.urlMaps.html +++ b/docs/dyn/compute_beta.urlMaps.html @@ -372,26 +372,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -409,15 +414,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -432,24 +437,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -461,15 +468,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -481,16 +489,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -506,27 +514,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -550,7 +558,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -1209,26 +1218,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -1246,15 +1260,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -1269,24 +1283,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1298,15 +1314,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1318,16 +1335,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -1343,27 +1360,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -1387,7 +1404,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -2027,26 +2045,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -2064,15 +2087,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -2087,24 +2110,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -2116,15 +2141,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -2136,16 +2162,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -2161,27 +2187,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -2205,7 +2231,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -3107,26 +3134,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -3144,15 +3176,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -3167,24 +3199,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -3196,15 +3230,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -3216,16 +3251,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -3241,27 +3276,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -3285,7 +3320,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -4324,26 +4360,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -4361,15 +4402,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -4384,24 +4425,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -4413,15 +4456,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -4433,16 +4477,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -4458,27 +4502,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -4502,7 +4546,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -5161,26 +5206,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -5198,15 +5248,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -5221,24 +5271,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5250,15 +5302,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5270,16 +5323,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -5295,27 +5348,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -5339,7 +5392,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -5979,26 +6033,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -6016,15 +6075,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -6039,24 +6098,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -6068,15 +6129,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -6088,16 +6150,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -6113,27 +6175,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -6157,7 +6219,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -7059,26 +7122,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -7096,15 +7164,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -7119,24 +7187,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -7148,15 +7218,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -7168,16 +7239,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -7193,27 +7264,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -7237,7 +7308,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -7895,26 +7967,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -7932,15 +8009,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -7955,24 +8032,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -7984,15 +8063,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -8004,16 +8084,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -8029,27 +8109,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -8073,7 +8153,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -8732,26 +8813,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -8769,15 +8855,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -8792,24 +8878,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -8821,15 +8909,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -8841,16 +8930,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -8866,27 +8955,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -8910,7 +8999,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -9550,26 +9640,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -9587,15 +9682,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -9610,24 +9705,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -9639,15 +9736,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -9659,16 +9757,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -9684,27 +9782,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -9728,7 +9826,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -10630,26 +10729,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -10667,15 +10771,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -10690,24 +10794,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -10719,15 +10825,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -10739,16 +10846,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -10764,27 +10871,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -10808,7 +10915,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -12160,26 +12268,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -12197,15 +12310,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -12220,24 +12333,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -12249,15 +12364,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -12269,16 +12385,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -12294,27 +12410,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -12338,7 +12454,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -12997,26 +13114,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -13034,15 +13156,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -13057,24 +13179,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -13086,15 +13210,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -13106,16 +13231,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -13131,27 +13256,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -13175,7 +13300,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -13815,26 +13941,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -13852,15 +13983,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -13875,24 +14006,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -13904,15 +14037,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -13924,16 +14058,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -13949,27 +14083,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -13993,7 +14127,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -14895,26 +15030,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -14932,15 +15072,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -14955,24 +15095,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -14984,15 +15126,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -15004,16 +15147,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -15029,27 +15172,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -15073,7 +15216,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -15782,26 +15926,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -15819,15 +15968,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -15842,24 +15991,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -15871,15 +16022,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -15891,16 +16043,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -15916,27 +16068,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -15960,7 +16112,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -16619,26 +16772,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -16656,15 +16814,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -16679,24 +16837,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -16708,15 +16868,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -16728,16 +16889,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -16753,27 +16914,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -16797,7 +16958,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -17437,26 +17599,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -17474,15 +17641,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -17497,24 +17664,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -17526,15 +17695,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -17546,16 +17716,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -17571,27 +17741,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -17615,7 +17785,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -18517,26 +18688,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -18554,15 +18730,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -18577,24 +18753,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -18606,15 +18784,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -18626,16 +18805,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -18651,27 +18830,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -18695,7 +18874,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -19671,26 +19851,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -19708,15 +19893,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -19731,24 +19916,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -19760,15 +19947,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -19780,16 +19968,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -19805,27 +19993,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -19849,7 +20037,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -20508,26 +20697,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -20545,15 +20739,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -20568,24 +20762,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -20597,15 +20793,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -20617,16 +20814,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -20642,27 +20839,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -20686,7 +20883,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -21326,26 +21524,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -21363,15 +21566,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -21386,24 +21589,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -21415,15 +21620,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -21435,16 +21641,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -21460,27 +21666,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -21504,7 +21710,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -22406,26 +22613,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -22443,15 +22655,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -22466,24 +22678,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -22495,15 +22709,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -22515,16 +22730,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -22540,27 +22755,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -22584,7 +22799,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -23546,26 +23762,31 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -23583,15 +23804,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -23606,24 +23827,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -23635,15 +23858,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -23655,16 +23879,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -23680,27 +23904,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -23724,7 +23948,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -24383,26 +24608,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -24420,15 +24650,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -24443,24 +24673,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -24472,15 +24704,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -24492,16 +24725,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -24517,27 +24750,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -24561,7 +24794,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -25201,26 +25435,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -25238,15 +25477,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -25261,24 +25500,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -25290,15 +25531,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -25310,16 +25552,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -25335,27 +25577,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -25379,7 +25621,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. @@ -26281,26 +26524,31 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Cache policy for this URL Map’s route. Available only for Global - # EXTERNAL_MANAGED load balancer schemes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 - # header names can be specified. The cache is bypassed for all - # cachePolicy.cacheMode settings. + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The CacheKeyPolicy for this CachePolicy. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. # Policy defined on Route Action. "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other - # parameters will be included. Either specify excluded_query_parameters or - # included_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "A String", ], "includeHost": True or False, # If true, requests to different hosts will be cached separately. @@ -26318,15 +26566,15 @@

Method Details

# set on a route that points exclusively to Backend Buckets will result in # a configuration error. "includeQueryString": True or False, # If true, include query string parameters in the cache key according to - # included_query_parameters and excluded_query_parameters. If neither is - # set, the entire query string will be included. If false, the query string - # will be excluded from the cache key entirely. + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. # # Note: This field applies to routes that use backend services. Attempting # to set it on a route that points exclusively to Backend Buckets will - # result in a configuration error. For routes that point to a Backend - # Bucket, use includedQueryParameters to define which parameters should - # be a part of the cache key. + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. # The name=value pair will be used in the cache key Cloud CDN generates. # @@ -26341,24 +26589,26 @@

Method Details

"A String", ], "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other - # parameters will be excluded. Either specify included_query_parameters or - # excluded_query_parameters, not both. '&' and '=' will be percent encoded - # and not treated as delimiters. + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. "A String", ], }, - "cacheMode": "A String", # Specifies the cache setting for all responses from this route. - # If not specified, the default value is CACHE_ALL_STATIC. - "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL. This is - # used to clamp the max-age (or Expires) value sent to the client. With - # FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the - # response max-age directive, along with a "public" directive. For - # cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age - # from the origin (if specified), or else sets the response max-age - # directive to the lesser of the client_ttl and default_ttl, and also - # ensures a "public" cache-control directive is present. - # If a client TTL is not specified, a default value (1 hour) will be used. - # The maximum allowed value is 31,622,400s (1 year). + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -26370,15 +26620,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content served by this origin for - # responses that do not have an existing valid TTL (max-age or s-maxage). - # Setting a TTL of "0" means "always revalidate". - # The value of defaultTTL cannot be set to a value greater than that of - # maxTTL. - # When the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL - # will overwrite the TTL set in all responses. The maximum allowed value is - # 31,622,400s (1 year). Infrequently accessed objects may be evicted from - # the cache before the defined TTL. + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -26390,16 +26641,16 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content served by this - # origin. - # Cache directives that attempt to set a max-age or s-maxage higher than - # this, or an Expires header more than maxTTL seconds in the future will - # be capped at the value of maxTTL, as if it were the value of an - # s-maxage Cache-Control directive. - # Headers sent to the client will not be modified. - # Setting a TTL of "0" means "always revalidate". - # The maximum allowed value is 31,622,400s (1 year). Infrequently accessed - # objects may be evicted from the cache before the defined TTL. + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -26415,27 +26666,27 @@

Method Details

# to apply fine-grained caching for common errors or redirects. # This can reduce the load on your origin and improve end-user # experience by reducing response latency. - # When the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, - # negative caching applies to responses with the specified response code - # that lack any Cache-Control, Expires, or Pragma: no-cache directives. - # When the cache mode is set to FORCE_CACHE_ALL, negative caching applies - # to all responses with the specified response code, and override any - # caching headers. - # By default, Cloud CDN will apply the following default TTLs to these - # status codes: - # HTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m - # HTTP 404 (Not Found), 410 (Gone), - # 451 (Unavailable For Legal Reasons): 120s - # HTTP 405 (Method Not Found), 501 (Not Implemented): 60s. - # These defaults can be overridden in negative_caching_policy. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. - # negative_caching must be enabled to configure negative_caching_policy. - # Omitting the policy and leaving negative_caching enabled will use - # Cloud CDN's default cache TTLs. - # Note that when specifying an explicit negative_caching_policy, you - # should take care to specify a cache TTL for all response codes - # that you wish to cache. Cloud CDN will not apply any default - # negative caching when a policy exists. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. { # Specify CDN TTLs for response error codes. "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be @@ -26459,7 +26710,8 @@

Method Details

}, ], "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill - # requests into a small number of requests to the origin. + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating # content with the origin, or when an error is encountered when refreshing # the cache. diff --git a/docs/dyn/compute_v1.regionUrlMaps.html b/docs/dyn/compute_v1.regionUrlMaps.html index d295a651de..5545bfa94f 100644 --- a/docs/dyn/compute_v1.regionUrlMaps.html +++ b/docs/dyn/compute_v1.regionUrlMaps.html @@ -548,6 +548,217 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -1183,6 +1394,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -1799,6 +2221,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -2635,51 +3268,262 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more - # information about the W3C recommendation for cross-origin resource sharing - # (CORS), see Fetch API Living - # Standard. - # - # Not supported when the URL map is bound to a target gRPC proxy. - # information about the W3C recommendation for cross-origin resource sharing - # (CORS), see Fetch API Living - # Standard. - "allowCredentials": True or False, # In response to a preflight request, setting this to true - # indicates that - # the actual request can include user credentials. This field translates to - # the Access-Control-Allow-Credentials header. - # - # Default is false. - "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers - # header. - "A String", - ], - "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods - # header. - "A String", - ], - "allowOriginRegexes": [ # Specifies a regular expression that matches allowed origins. For - # more information, see regular expression syntax. - # - # An origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes. - # - # Regular expressions can only be used when the loadBalancingScheme is - # set to INTERNAL_SELF_MANAGED. - "A String", - ], - "allowOrigins": [ # Specifies the list of origins that is allowed to do CORS requests. - # - # An origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "disabled": True or False, # If true, disables the CORS policy. - # The default value is false, which indicates that the CORS - # policy is in effect. - "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers - # header. - "A String", - ], - "maxAge": 42, # Specifies how long results of a preflight request can be cached in + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more + # information about the W3C recommendation for cross-origin resource sharing + # (CORS), see Fetch API Living + # Standard. + # + # Not supported when the URL map is bound to a target gRPC proxy. + # information about the W3C recommendation for cross-origin resource sharing + # (CORS), see Fetch API Living + # Standard. + "allowCredentials": True or False, # In response to a preflight request, setting this to true + # indicates that + # the actual request can include user credentials. This field translates to + # the Access-Control-Allow-Credentials header. + # + # Default is false. + "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers + # header. + "A String", + ], + "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods + # header. + "A String", + ], + "allowOriginRegexes": [ # Specifies a regular expression that matches allowed origins. For + # more information, see regular expression syntax. + # + # An origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes. + # + # Regular expressions can only be used when the loadBalancingScheme is + # set to INTERNAL_SELF_MANAGED. + "A String", + ], + "allowOrigins": [ # Specifies the list of origins that is allowed to do CORS requests. + # + # An origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes. + "A String", + ], + "disabled": True or False, # If true, disables the CORS policy. + # The default value is false, which indicates that the CORS + # policy is in effect. + "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers + # header. + "A String", + ], + "maxAge": 42, # Specifies how long results of a preflight request can be cached in # seconds. This field translates to the Access-Control-Max-Age # header. }, @@ -3264,6 +4108,217 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -3899,6 +4954,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -4515,6 +5781,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -5351,6 +6828,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -6344,6 +8032,217 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -6979,6 +8878,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -7595,6 +9705,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -8431,6 +10752,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -9111,6 +11643,217 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -9746,6 +12489,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -10326,42 +13280,253 @@

Method Details

# The value must # be from 1 to 1024 characters }, - ], - "errorService": "A String", # The full or partial URL to the BackendBucket resource that - # contains the custom error content. Examples are: - # - # - # - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - # - compute/v1/projects/project/global/backendBuckets/myBackendBucket - # - global/backendBuckets/myBackendBucket - # - # If errorService is not specified at lower levels likepathMatcher, pathRule and routeRule, - # an errorService specified at a higher level in theUrlMap will be used. IfUrlMap.defaultCustomErrorResponsePolicy contains one or moreerrorResponseRules[], it must specifyerrorService. - # - # If load balancer cannot reach - # the backendBucket, a simple Not Found Error will - # be returned, with the original response code (oroverrideResponseCode if configured). - # - # errorService is not supported for internal or regionalHTTP/HTTPS load balancers. - }, - "paths": [ # The list of path patterns to match. Each must start with / - # and the only place a * is allowed is at the end following - # a /. The string fed to the path matcher does not include - # any text after the first ? or #, and - # those chars are not allowed here. - "A String", - ], - "routeAction": { # In response to a matching path, the load balancer - # performs advanced routing actions, such as URL rewrites and header - # transformations, before forwarding the request to the selected - # backend. - # - # - # Only one of urlRedirect, service orrouteAction.weightedBackendService can be set. - # - # - # URL maps for classic Application Load Balancers only support - # the urlRewrite action within a path rule'srouteAction. + ], + "errorService": "A String", # The full or partial URL to the BackendBucket resource that + # contains the custom error content. Examples are: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket + # - compute/v1/projects/project/global/backendBuckets/myBackendBucket + # - global/backendBuckets/myBackendBucket + # + # If errorService is not specified at lower levels likepathMatcher, pathRule and routeRule, + # an errorService specified at a higher level in theUrlMap will be used. IfUrlMap.defaultCustomErrorResponsePolicy contains one or moreerrorResponseRules[], it must specifyerrorService. + # + # If load balancer cannot reach + # the backendBucket, a simple Not Found Error will + # be returned, with the original response code (oroverrideResponseCode if configured). + # + # errorService is not supported for internal or regionalHTTP/HTTPS load balancers. + }, + "paths": [ # The list of path patterns to match. Each must start with / + # and the only place a * is allowed is at the end following + # a /. The string fed to the path matcher does not include + # any text after the first ? or #, and + # those chars are not allowed here. + "A String", + ], + "routeAction": { # In response to a matching path, the load balancer + # performs advanced routing actions, such as URL rewrites and header + # transformations, before forwarding the request to the selected + # backend. + # + # + # Only one of urlRedirect, service orrouteAction.weightedBackendService can be set. + # + # + # URL maps for classic Application Load Balancers only support + # the urlRewrite action within a path rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -11198,6 +14363,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -12101,6 +15477,217 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -12736,6 +16323,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -13352,6 +17150,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -14188,6 +18197,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -15058,41 +19278,252 @@

Method Details

# The value must # be from 1 to 1024 characters }, - ], - "errorService": "A String", # The full or partial URL to the BackendBucket resource that - # contains the custom error content. Examples are: - # - # - # - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - # - compute/v1/projects/project/global/backendBuckets/myBackendBucket - # - global/backendBuckets/myBackendBucket - # - # If errorService is not specified at lower levels likepathMatcher, pathRule and routeRule, - # an errorService specified at a higher level in theUrlMap will be used. IfUrlMap.defaultCustomErrorResponsePolicy contains one or moreerrorResponseRules[], it must specifyerrorService. - # - # If load balancer cannot reach - # the backendBucket, a simple Not Found Error will - # be returned, with the original response code (oroverrideResponseCode if configured). - # - # errorService is not supported for internal or regionalHTTP/HTTPS load balancers. - }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the - # hostRules match. The load balancer performs advanced routing - # actions, such as URL rewrites and header transformations, before forwarding - # the request to the selected backend. - # - # - # Only one of defaultUrlRedirect, defaultService - # or defaultRouteAction.weightedBackendService can be set. - # - # - # URL maps for classic Application Load Balancers only support - # the urlRewrite action within defaultRouteAction. - # - # - # defaultRouteAction has no effect when the URL map is bound - # to a target gRPC proxy that has the validateForProxyless field - # set to true. + ], + "errorService": "A String", # The full or partial URL to the BackendBucket resource that + # contains the custom error content. Examples are: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket + # - compute/v1/projects/project/global/backendBuckets/myBackendBucket + # - global/backendBuckets/myBackendBucket + # + # If errorService is not specified at lower levels likepathMatcher, pathRule and routeRule, + # an errorService specified at a higher level in theUrlMap will be used. IfUrlMap.defaultCustomErrorResponsePolicy contains one or moreerrorResponseRules[], it must specifyerrorService. + # + # If load balancer cannot reach + # the backendBucket, a simple Not Found Error will + # be returned, with the original response code (oroverrideResponseCode if configured). + # + # errorService is not supported for internal or regionalHTTP/HTTPS load balancers. + }, + "defaultRouteAction": { # defaultRouteAction takes effect when none of the + # hostRules match. The load balancer performs advanced routing + # actions, such as URL rewrites and header transformations, before forwarding + # the request to the selected backend. + # + # + # Only one of defaultUrlRedirect, defaultService + # or defaultRouteAction.weightedBackendService can be set. + # + # + # URL maps for classic Application Load Balancers only support + # the urlRewrite action within defaultRouteAction. + # + # + # defaultRouteAction has no effect when the URL map is bound + # to a target gRPC proxy that has the validateForProxyless field + # set to true. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -15728,6 +20159,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -16344,6 +20986,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -17180,6 +22033,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living diff --git a/docs/dyn/compute_v1.urlMaps.html b/docs/dyn/compute_v1.urlMaps.html index ec1bb04587..57aec8b073 100644 --- a/docs/dyn/compute_v1.urlMaps.html +++ b/docs/dyn/compute_v1.urlMaps.html @@ -372,6 +372,217 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -1007,6 +1218,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -1623,6 +2045,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -2459,52 +3092,263 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more - # information about the W3C recommendation for cross-origin resource sharing - # (CORS), see Fetch API Living - # Standard. - # - # Not supported when the URL map is bound to a target gRPC proxy. - # information about the W3C recommendation for cross-origin resource sharing - # (CORS), see Fetch API Living - # Standard. - "allowCredentials": True or False, # In response to a preflight request, setting this to true - # indicates that - # the actual request can include user credentials. This field translates to - # the Access-Control-Allow-Credentials header. - # - # Default is false. - "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers - # header. - "A String", - ], - "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods - # header. - "A String", - ], - "allowOriginRegexes": [ # Specifies a regular expression that matches allowed origins. For - # more information, see regular expression syntax. - # - # An origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes. - # - # Regular expressions can only be used when the loadBalancingScheme is - # set to INTERNAL_SELF_MANAGED. - "A String", - ], - "allowOrigins": [ # Specifies the list of origins that is allowed to do CORS requests. - # - # An origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes. - "A String", - ], - "disabled": True or False, # If true, disables the CORS policy. - # The default value is false, which indicates that the CORS - # policy is in effect. - "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers - # header. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "maxAge": 42, # Specifies how long results of a preflight request can be cached in - # seconds. This field translates to the Access-Control-Max-Age + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more + # information about the W3C recommendation for cross-origin resource sharing + # (CORS), see Fetch API Living + # Standard. + # + # Not supported when the URL map is bound to a target gRPC proxy. + # information about the W3C recommendation for cross-origin resource sharing + # (CORS), see Fetch API Living + # Standard. + "allowCredentials": True or False, # In response to a preflight request, setting this to true + # indicates that + # the actual request can include user credentials. This field translates to + # the Access-Control-Allow-Credentials header. + # + # Default is false. + "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers + # header. + "A String", + ], + "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods + # header. + "A String", + ], + "allowOriginRegexes": [ # Specifies a regular expression that matches allowed origins. For + # more information, see regular expression syntax. + # + # An origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes. + # + # Regular expressions can only be used when the loadBalancingScheme is + # set to INTERNAL_SELF_MANAGED. + "A String", + ], + "allowOrigins": [ # Specifies the list of origins that is allowed to do CORS requests. + # + # An origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes. + "A String", + ], + "disabled": True or False, # If true, disables the CORS policy. + # The default value is false, which indicates that the CORS + # policy is in effect. + "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers + # header. + "A String", + ], + "maxAge": 42, # Specifies how long results of a preflight request can be cached in + # seconds. This field translates to the Access-Control-Max-Age # header. }, "faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test # The specification for fault injection introduced into traffic to test @@ -3468,6 +4312,217 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -4103,6 +5158,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -4719,14 +5985,225 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. - "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more - # information about the W3C recommendation for cross-origin resource sharing - # (CORS), see Fetch API Living - # Standard. - # - # Not supported when the URL map is bound to a target gRPC proxy. - # information about the W3C recommendation for cross-origin resource sharing - # (CORS), see Fetch API Living + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more + # information about the W3C recommendation for cross-origin resource sharing + # (CORS), see Fetch API Living + # Standard. + # + # Not supported when the URL map is bound to a target gRPC proxy. + # information about the W3C recommendation for cross-origin resource sharing + # (CORS), see Fetch API Living # Standard. "allowCredentials": True or False, # In response to a preflight request, setting this to true # indicates that @@ -5555,6 +7032,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -6183,6 +7871,217 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -6818,47 +8717,258 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. - "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more - # information about the W3C recommendation for cross-origin resource sharing - # (CORS), see Fetch API Living - # Standard. - # - # Not supported when the URL map is bound to a target gRPC proxy. - # information about the W3C recommendation for cross-origin resource sharing - # (CORS), see Fetch API Living - # Standard. - "allowCredentials": True or False, # In response to a preflight request, setting this to true - # indicates that - # the actual request can include user credentials. This field translates to - # the Access-Control-Allow-Credentials header. - # - # Default is false. - "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers - # header. - "A String", - ], - "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods - # header. - "A String", - ], - "allowOriginRegexes": [ # Specifies a regular expression that matches allowed origins. For - # more information, see regular expression syntax. - # - # An origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes. - # - # Regular expressions can only be used when the loadBalancingScheme is - # set to INTERNAL_SELF_MANAGED. - "A String", - ], - "allowOrigins": [ # Specifies the list of origins that is allowed to do CORS requests. - # - # An origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "disabled": True or False, # If true, disables the CORS policy. - # The default value is false, which indicates that the CORS - # policy is in effect. - "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more + # information about the W3C recommendation for cross-origin resource sharing + # (CORS), see Fetch API Living + # Standard. + # + # Not supported when the URL map is bound to a target gRPC proxy. + # information about the W3C recommendation for cross-origin resource sharing + # (CORS), see Fetch API Living + # Standard. + "allowCredentials": True or False, # In response to a preflight request, setting this to true + # indicates that + # the actual request can include user credentials. This field translates to + # the Access-Control-Allow-Credentials header. + # + # Default is false. + "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers + # header. + "A String", + ], + "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods + # header. + "A String", + ], + "allowOriginRegexes": [ # Specifies a regular expression that matches allowed origins. For + # more information, see regular expression syntax. + # + # An origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes. + # + # Regular expressions can only be used when the loadBalancingScheme is + # set to INTERNAL_SELF_MANAGED. + "A String", + ], + "allowOrigins": [ # Specifies the list of origins that is allowed to do CORS requests. + # + # An origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes. + "A String", + ], + "disabled": True or False, # If true, disables the CORS policy. + # The default value is false, which indicates that the CORS + # policy is in effect. + "exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers # header. "A String", ], @@ -7434,6 +9544,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -8270,6 +10591,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -9592,14 +12124,225 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. - "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more - # information about the W3C recommendation for cross-origin resource sharing - # (CORS), see Fetch API Living - # Standard. - # - # Not supported when the URL map is bound to a target gRPC proxy. - # information about the W3C recommendation for cross-origin resource sharing - # (CORS), see Fetch API Living + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more + # information about the W3C recommendation for cross-origin resource sharing + # (CORS), see Fetch API Living + # Standard. + # + # Not supported when the URL map is bound to a target gRPC proxy. + # information about the W3C recommendation for cross-origin resource sharing + # (CORS), see Fetch API Living # Standard. "allowCredentials": True or False, # In response to a preflight request, setting this to true # indicates that @@ -10227,6 +12970,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -10843,6 +13797,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -11679,41 +14844,252 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. - "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more - # information about the W3C recommendation for cross-origin resource sharing - # (CORS), see Fetch API Living - # Standard. - # - # Not supported when the URL map is bound to a target gRPC proxy. - # information about the W3C recommendation for cross-origin resource sharing - # (CORS), see Fetch API Living - # Standard. - "allowCredentials": True or False, # In response to a preflight request, setting this to true - # indicates that - # the actual request can include user credentials. This field translates to - # the Access-Control-Allow-Credentials header. - # - # Default is false. - "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers - # header. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. "A String", ], - "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods - # header. - "A String", - ], - "allowOriginRegexes": [ # Specifies a regular expression that matches allowed origins. For - # more information, see regular expression syntax. - # - # An origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes. - # - # Regular expressions can only be used when the loadBalancingScheme is - # set to INTERNAL_SELF_MANAGED. - "A String", - ], - "allowOrigins": [ # Specifies the list of origins that is allowed to do CORS requests. - # - # An origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes. + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more + # information about the W3C recommendation for cross-origin resource sharing + # (CORS), see Fetch API Living + # Standard. + # + # Not supported when the URL map is bound to a target gRPC proxy. + # information about the W3C recommendation for cross-origin resource sharing + # (CORS), see Fetch API Living + # Standard. + "allowCredentials": True or False, # In response to a preflight request, setting this to true + # indicates that + # the actual request can include user credentials. This field translates to + # the Access-Control-Allow-Credentials header. + # + # Default is false. + "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers + # header. + "A String", + ], + "allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods + # header. + "A String", + ], + "allowOriginRegexes": [ # Specifies a regular expression that matches allowed origins. For + # more information, see regular expression syntax. + # + # An origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes. + # + # Regular expressions can only be used when the loadBalancingScheme is + # set to INTERNAL_SELF_MANAGED. + "A String", + ], + "allowOrigins": [ # Specifies the list of origins that is allowed to do CORS requests. + # + # An origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes. "A String", ], "disabled": True or False, # If true, disables the CORS policy. @@ -12358,6 +15734,217 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -12993,6 +16580,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -13573,42 +17371,253 @@

Method Details

# The value must # be from 1 to 1024 characters }, - ], - "errorService": "A String", # The full or partial URL to the BackendBucket resource that - # contains the custom error content. Examples are: - # - # - # - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - # - compute/v1/projects/project/global/backendBuckets/myBackendBucket - # - global/backendBuckets/myBackendBucket - # - # If errorService is not specified at lower levels likepathMatcher, pathRule and routeRule, - # an errorService specified at a higher level in theUrlMap will be used. IfUrlMap.defaultCustomErrorResponsePolicy contains one or moreerrorResponseRules[], it must specifyerrorService. - # - # If load balancer cannot reach - # the backendBucket, a simple Not Found Error will - # be returned, with the original response code (oroverrideResponseCode if configured). - # - # errorService is not supported for internal or regionalHTTP/HTTPS load balancers. - }, - "paths": [ # The list of path patterns to match. Each must start with / - # and the only place a * is allowed is at the end following - # a /. The string fed to the path matcher does not include - # any text after the first ? or #, and - # those chars are not allowed here. - "A String", - ], - "routeAction": { # In response to a matching path, the load balancer - # performs advanced routing actions, such as URL rewrites and header - # transformations, before forwarding the request to the selected - # backend. - # - # - # Only one of urlRedirect, service orrouteAction.weightedBackendService can be set. - # - # - # URL maps for classic Application Load Balancers only support - # the urlRewrite action within a path rule'srouteAction. + ], + "errorService": "A String", # The full or partial URL to the BackendBucket resource that + # contains the custom error content. Examples are: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket + # - compute/v1/projects/project/global/backendBuckets/myBackendBucket + # - global/backendBuckets/myBackendBucket + # + # If errorService is not specified at lower levels likepathMatcher, pathRule and routeRule, + # an errorService specified at a higher level in theUrlMap will be used. IfUrlMap.defaultCustomErrorResponsePolicy contains one or moreerrorResponseRules[], it must specifyerrorService. + # + # If load balancer cannot reach + # the backendBucket, a simple Not Found Error will + # be returned, with the original response code (oroverrideResponseCode if configured). + # + # errorService is not supported for internal or regionalHTTP/HTTPS load balancers. + }, + "paths": [ # The list of path patterns to match. Each must start with / + # and the only place a * is allowed is at the end following + # a /. The string fed to the path matcher does not include + # any text after the first ? or #, and + # those chars are not allowed here. + "A String", + ], + "routeAction": { # In response to a matching path, the load balancer + # performs advanced routing actions, such as URL rewrites and header + # transformations, before forwarding the request to the selected + # backend. + # + # + # Only one of urlRedirect, service orrouteAction.weightedBackendService can be set. + # + # + # URL maps for classic Application Load Balancers only support + # the urlRewrite action within a path rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -14445,6 +18454,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -15391,6 +19611,217 @@

Method Details

# defaultRouteAction has no effect when the URL map is bound # to a target gRPC proxy that has the validateForProxyless field # set to true. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -16026,6 +20457,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -16642,6 +21284,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -17478,6 +22331,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -18375,41 +23439,252 @@

Method Details

# The value must # be from 1 to 1024 characters }, - ], - "errorService": "A String", # The full or partial URL to the BackendBucket resource that - # contains the custom error content. Examples are: - # - # - # - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - # - compute/v1/projects/project/global/backendBuckets/myBackendBucket - # - global/backendBuckets/myBackendBucket - # - # If errorService is not specified at lower levels likepathMatcher, pathRule and routeRule, - # an errorService specified at a higher level in theUrlMap will be used. IfUrlMap.defaultCustomErrorResponsePolicy contains one or moreerrorResponseRules[], it must specifyerrorService. - # - # If load balancer cannot reach - # the backendBucket, a simple Not Found Error will - # be returned, with the original response code (oroverrideResponseCode if configured). - # - # errorService is not supported for internal or regionalHTTP/HTTPS load balancers. - }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the - # hostRules match. The load balancer performs advanced routing - # actions, such as URL rewrites and header transformations, before forwarding - # the request to the selected backend. - # - # - # Only one of defaultUrlRedirect, defaultService - # or defaultRouteAction.weightedBackendService can be set. - # - # - # URL maps for classic Application Load Balancers only support - # the urlRewrite action within defaultRouteAction. - # - # - # defaultRouteAction has no effect when the URL map is bound - # to a target gRPC proxy that has the validateForProxyless field - # set to true. + ], + "errorService": "A String", # The full or partial URL to the BackendBucket resource that + # contains the custom error content. Examples are: + # + # + # - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket + # - compute/v1/projects/project/global/backendBuckets/myBackendBucket + # - global/backendBuckets/myBackendBucket + # + # If errorService is not specified at lower levels likepathMatcher, pathRule and routeRule, + # an errorService specified at a higher level in theUrlMap will be used. IfUrlMap.defaultCustomErrorResponsePolicy contains one or moreerrorResponseRules[], it must specifyerrorService. + # + # If load balancer cannot reach + # the backendBucket, a simple Not Found Error will + # be returned, with the original response code (oroverrideResponseCode if configured). + # + # errorService is not supported for internal or regionalHTTP/HTTPS load balancers. + }, + "defaultRouteAction": { # defaultRouteAction takes effect when none of the + # hostRules match. The load balancer performs advanced routing + # actions, such as URL rewrites and header transformations, before forwarding + # the request to the selected backend. + # + # + # Only one of defaultUrlRedirect, defaultService + # or defaultRouteAction.weightedBackendService can be set. + # + # + # URL maps for classic Application Load Balancers only support + # the urlRewrite action within defaultRouteAction. + # + # + # defaultRouteAction has no effect when the URL map is bound + # to a target gRPC proxy that has the validateForProxyless field + # set to true. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -19045,6 +24320,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path matcher'sdefaultRouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -19661,6 +25147,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a path rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living @@ -20497,6 +26194,217 @@

Method Details

# # URL maps for classic Application Load Balancers only support # the urlRewrite action within a route rule'srouteAction. + "cachePolicy": { # Message containing CachePolicy configuration for URL Map's Route Action. # Specifies the cache policy configuration for matched traffic. Available + # only for Global `EXTERNAL_MANAGED` load balancer schemes. At least one + # property must be specified. This policy cannot be specified if any target + # backend has Identity-Aware Proxy enabled. + "cacheBypassRequestHeaderNames": [ # Bypass the cache when the specified request headers are matched by name, + # e.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5 + # header names can be specified. The cache is bypassed for all `cacheMode` + # values. + "A String", + ], + "cacheKeyPolicy": { # Message containing what to include in the cache key for a request for Cache # The cache key configuration. If not specified, the default behavior depends + # on the backend type: for Backend Services, the complete request URI is + # used; for Backend Buckets, the request URI is used without the protocol or + # host, and only query parameters known to Cloud Storage are included. + # Policy defined on Route Action. + "excludedQueryParameters": [ # Names of query string parameters to exclude in cache keys. All other + # parameters will be included. Either specify `excludedQueryParameters` + # or `includedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "A String", + ], + "includeHost": True or False, # If true, requests to different hosts will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # host is never included in a Backend Bucket's cache key. Attempting to set + # it on a route that points exclusively to Backend Buckets will result in a + # configuration error. + "includeProtocol": True or False, # If true, http and https requests will be cached separately. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket, as the + # protocol is never included in a Backend Bucket's cache key. Attempting to + # set on a route that points exclusively to Backend Buckets will result in + # a configuration error. + "includeQueryString": True or False, # If true, include query string parameters in the cache key according to + # `includedQueryParameters` and `excludedQueryParameters`. If neither + # is set, the entire query string will be included. If false, the query + # string will be excluded from the cache key entirely. + # + # Note: This field applies to routes that use backend services. Attempting + # to set it on a route that points exclusively to Backend Buckets will + # result in a configuration error. For routes that point to a Backend + # Bucket, use `includedQueryParameters` to define which parameters should + # be part of the cache key. + "includedCookieNames": [ # Allows HTTP cookies (by name) to be used in the cache key. + # The name=value pair will be used in the cache key Cloud CDN generates. + # + # Note: This setting is only applicable to routes that use a Backend + # Service. It does not affect requests served by a Backend Bucket. + # Attempting to set it on a route that points exclusively to Backend + # Buckets will result in a configuration error. Up to 5 cookie names can be + # specified. + "A String", + ], + "includedHeaderNames": [ # Allows HTTP request headers (by name) to be used in the cache key. + "A String", + ], + "includedQueryParameters": [ # Names of query string parameters to include in cache keys. All other + # parameters will be excluded. Either specify `includedQueryParameters` + # or `excludedQueryParameters`, not both. '&' and '=' will be percent + # encoded and not treated as delimiters. + "A String", + ], + }, + "cacheMode": "A String", # Specifies the cache setting for all responses from this route. If not + # specified, Cloud CDN uses `CACHE_ALL_STATIC` mode. + "clientTtl": { # A Duration represents a fixed-length span of time represented # Specifies a separate client (e.g. browser client) maximum TTL for cached + # content. This is used to clamp the max-age (or Expires) value sent to the + # client. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl` + # is used for the response max-age directive, along with a "public" + # directive. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl` + # clamps the max-age from the origin (if specified), or else sets the + # response max-age directive to the lesser of the `clientTtl` and + # `defaultTtl`, and also ensures a "public" cache-control directive is + # present. The maximum allowed value is 31,622,400s (1 year). If not + # specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode. + # Cannot exceed `maxTtl`. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "defaultTtl": { # A Duration represents a fixed-length span of time represented # Specifies the default TTL for cached content for responses that do not have + # an existing valid TTL (max-age or s-maxage). Setting a TTL of "0" means + # "always revalidate". The value of `defaultTtl` cannot be set to a value + # greater than that of `maxTtl`. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all + # responses. The maximum allowed value is 31,622,400s (1 year). Infrequently + # accessed objects may be evicted from the cache before the defined TTL. If + # not specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and + # `FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is + # `USE_ORIGIN_HEADERS`. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "maxTtl": { # A Duration represents a fixed-length span of time represented # Specifies the maximum allowed TTL for cached content. Cache directives that + # attempt to set a max-age or s-maxage higher than this, or an Expires header + # more than `maxTtl` seconds in the future will be capped at the value of + # `maxTtl`, as if it were the value of an s-maxage Cache-Control directive. + # Headers sent to the client will not be modified. Setting a TTL of "0" means + # "always revalidate". The maximum allowed value is 31,622,400s (1 year). + # Infrequently accessed objects may be evicted from the cache before the + # defined TTL. If not specified, Cloud CDN uses 86400s (1 day) for + # `CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache + # mode. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "negativeCaching": True or False, # Negative caching allows per-status code TTLs to be set, in order + # to apply fine-grained caching for common errors or redirects. + # This can reduce the load on your origin and improve end-user + # experience by reducing response latency. + # When the `cacheMode` is set to `CACHE_ALL_STATIC` or + # `USE_ORIGIN_HEADERS`, negative caching applies to responses with + # the specified response code that lack any Cache-Control, Expires, or + # Pragma: no-cache directives. When the `cacheMode` is set to + # `FORCE_CACHE_ALL`, negative caching applies to all responses + # with the specified response code, and overrides any caching headers. By + # default, Cloud CDN applies the following TTLs to these HTTP status codes: + # + # * 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m + # * 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s + # * 405 (Method Not Found), 501 (Not Implemented): 60s + # + # These defaults can be overridden in `negativeCachingPolicy`. + # If not specified, Cloud CDN applies negative caching by default. + "negativeCachingPolicy": [ # Sets a cache TTL for the specified HTTP status code. + # `negativeCaching` must be enabled to configure `negativeCachingPolicy`. + # Omitting the policy and leaving `negativeCaching` enabled will use Cloud + # CDN's default cache TTLs. Note that when specifying an explicit + # `negativeCachingPolicy`, you should take care to specify a cache TTL for + # all response codes that you wish to cache. Cloud CDN will not apply any + # default negative caching when a policy exists. + { # Specify CDN TTLs for response error codes. + "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes + # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be + # specified as values, and you cannot specify a status code more than + # once. + "ttl": { # A Duration represents a fixed-length span of time represented # The TTL (in seconds) for which to cache responses with the + # corresponding status code. + # The maximum allowed value is 1800s (30 minutes). Infrequently accessed + # objects may be evicted from the cache before the defined TTL. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, + ], + "requestCoalescing": True or False, # If true then Cloud CDN will combine multiple concurrent cache fill + # requests into a small number of requests to the origin. If not specified, + # Cloud CDN applies request coalescing by default. + "serveWhileStale": { # A Duration represents a fixed-length span of time represented # Serve existing content from the cache (if available) when revalidating + # content with the origin, or when an error is encountered when refreshing + # the cache. + # This setting defines the default "max-stale" duration for any cached + # responses that do not specify a max-stale directive. Stale responses that + # exceed the TTL configured here will not be served. The default limit + # (max-stale) is 86400s (1 day), which will allow stale content to be + # served up to this limit beyond the max-age (or s-maxage) of a cached + # response. + # The maximum allowed value is 604800 (1 week). + # Set this to zero (0) to disable serve-while-stale. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more # The specification for allowing client-side cross-origin requests. For more # information about the W3C recommendation for cross-origin resource sharing # (CORS), see Fetch API Living diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index 245112d08e..8f4f9e790f 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -54919,7 +54919,7 @@ } } }, -"revision": "20260331", +"revision": "20260410", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -61224,7 +61224,7 @@ false "id": "CachePolicy", "properties": { "cacheBypassRequestHeaderNames": { -"description": "Bypass the cache when the specified request headers are matched by name,\ne.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5\nheader names can be specified. The cache is bypassed for all\ncachePolicy.cacheMode settings.", +"description": "Bypass the cache when the specified request headers are matched by name,\ne.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5\nheader names can be specified. The cache is bypassed for all `cacheMode`\nvalues.", "items": { "type": "string" }, @@ -61232,10 +61232,10 @@ false }, "cacheKeyPolicy": { "$ref": "CachePolicyCacheKeyPolicy", -"description": "The CacheKeyPolicy for this CachePolicy." +"description": "The cache key configuration. If not specified, the default behavior depends\non the backend type: for Backend Services, the complete request URI is\nused; for Backend Buckets, the request URI is used without the protocol or\nhost, and only query parameters known to Cloud Storage are included." }, "cacheMode": { -"description": "Specifies the cache setting for all responses from this route.\nIf not specified, the default value is CACHE_ALL_STATIC.", +"description": "Specifies the cache setting for all responses from this route. If not\nspecified, Cloud CDN uses `CACHE_ALL_STATIC` mode.", "enum": [ "CACHE_ALL_STATIC", "FORCE_CACHE_ALL", @@ -61250,29 +61250,29 @@ false }, "clientTtl": { "$ref": "Duration", -"description": "Specifies a separate client (e.g. browser client) maximum TTL. This is\nused to clamp the max-age (or Expires) value sent to the client. With\nFORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the\nresponse max-age directive, along with a \"public\" directive. For\ncacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age\nfrom the origin (if specified), or else sets the response max-age\ndirective to the lesser of the client_ttl and default_ttl, and also\nensures a \"public\" cache-control directive is present.\nIf a client TTL is not specified, a default value (1 hour) will be used.\nThe maximum allowed value is 31,622,400s (1 year)." +"description": "Specifies a separate client (e.g. browser client) maximum TTL for cached\ncontent. This is used to clamp the max-age (or Expires) value sent to the\nclient. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl`\nis used for the response max-age directive, along with a \"public\"\ndirective. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl`\nclamps the max-age from the origin (if specified), or else sets the\nresponse max-age directive to the lesser of the `clientTtl` and\n`defaultTtl`, and also ensures a \"public\" cache-control directive is\npresent. The maximum allowed value is 31,622,400s (1 year). If not\nspecified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode.\nCannot exceed `maxTtl`. Cannot be specified when `cacheMode` is\n`USE_ORIGIN_HEADERS`." }, "defaultTtl": { "$ref": "Duration", -"description": "Specifies the default TTL for cached content served by this origin for\nresponses that do not have an existing valid TTL (max-age or s-maxage).\nSetting a TTL of \"0\" means \"always revalidate\".\nThe value of defaultTTL cannot be set to a value greater than that of\nmaxTTL.\nWhen the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL\nwill overwrite the TTL set in all responses. The maximum allowed value is\n31,622,400s (1 year). Infrequently accessed objects may be evicted from\nthe cache before the defined TTL." +"description": "Specifies the default TTL for cached content for responses that do not have\nan existing valid TTL (max-age or s-maxage). Setting a TTL of \"0\" means\n\"always revalidate\". The value of `defaultTtl` cannot be set to a value\ngreater than that of `maxTtl`. When the `cacheMode` is set to\n`FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all\nresponses. The maximum allowed value is 31,622,400s (1 year). Infrequently\naccessed objects may be evicted from the cache before the defined TTL. If\nnot specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and\n`FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is\n`USE_ORIGIN_HEADERS`." }, "maxTtl": { "$ref": "Duration", -"description": "Specifies the maximum allowed TTL for cached content served by this\norigin.\nCache directives that attempt to set a max-age or s-maxage higher than\nthis, or an Expires header more than maxTTL seconds in the future will\nbe capped at the value of maxTTL, as if it were the value of an\ns-maxage Cache-Control directive.\nHeaders sent to the client will not be modified.\nSetting a TTL of \"0\" means \"always revalidate\".\nThe maximum allowed value is 31,622,400s (1 year). Infrequently accessed\nobjects may be evicted from the cache before the defined TTL." +"description": "Specifies the maximum allowed TTL for cached content. Cache directives that\nattempt to set a max-age or s-maxage higher than this, or an Expires header\nmore than `maxTtl` seconds in the future will be capped at the value of\n`maxTtl`, as if it were the value of an s-maxage Cache-Control directive.\nHeaders sent to the client will not be modified. Setting a TTL of \"0\" means\n\"always revalidate\". The maximum allowed value is 31,622,400s (1 year).\nInfrequently accessed objects may be evicted from the cache before the\ndefined TTL. If not specified, Cloud CDN uses 86400s (1 day) for\n`CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache\nmode." }, "negativeCaching": { -"description": "Negative caching allows per-status code TTLs to be set, in order\nto apply fine-grained caching for common errors or redirects.\nThis can reduce the load on your origin and improve end-user\nexperience by reducing response latency.\nWhen the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,\nnegative caching applies to responses with the specified response code\nthat lack any Cache-Control, Expires, or Pragma: no-cache directives.\nWhen the cache mode is set to FORCE_CACHE_ALL, negative caching applies\nto all responses with the specified response code, and override any\ncaching headers.\nBy default, Cloud CDN will apply the following default TTLs to these\nstatus codes:\nHTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m\nHTTP 404 (Not Found), 410 (Gone),\n451 (Unavailable For Legal Reasons): 120s\nHTTP 405 (Method Not Found), 501 (Not Implemented): 60s.\nThese defaults can be overridden in negative_caching_policy.", +"description": "Negative caching allows per-status code TTLs to be set, in order\nto apply fine-grained caching for common errors or redirects.\nThis can reduce the load on your origin and improve end-user\nexperience by reducing response latency.\nWhen the `cacheMode` is set to `CACHE_ALL_STATIC` or\n`USE_ORIGIN_HEADERS`, negative caching applies to responses with\nthe specified response code that lack any Cache-Control, Expires, or\nPragma: no-cache directives. When the `cacheMode` is set to\n`FORCE_CACHE_ALL`, negative caching applies to all responses\nwith the specified response code, and overrides any caching headers. By\ndefault, Cloud CDN applies the following TTLs to these HTTP status codes:\n\n* 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m\n* 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s\n* 405 (Method Not Found), 501 (Not Implemented): 60s\n\nThese defaults can be overridden in `negativeCachingPolicy`.\nIf not specified, Cloud CDN applies negative caching by default.", "type": "boolean" }, "negativeCachingPolicy": { -"description": "Sets a cache TTL for the specified HTTP status code.\nnegative_caching must be enabled to configure negative_caching_policy.\nOmitting the policy and leaving negative_caching enabled will use\nCloud CDN's default cache TTLs.\nNote that when specifying an explicit negative_caching_policy, you\nshould take care to specify a cache TTL for all response codes\nthat you wish to cache. Cloud CDN will not apply any default\nnegative caching when a policy exists.", +"description": "Sets a cache TTL for the specified HTTP status code.\n`negativeCaching` must be enabled to configure `negativeCachingPolicy`.\nOmitting the policy and leaving `negativeCaching` enabled will use Cloud\nCDN's default cache TTLs. Note that when specifying an explicit\n`negativeCachingPolicy`, you should take care to specify a cache TTL for\nall response codes that you wish to cache. Cloud CDN will not apply any\ndefault negative caching when a policy exists.", "items": { "$ref": "CachePolicyNegativeCachingPolicy" }, "type": "array" }, "requestCoalescing": { -"description": "If true then Cloud CDN will combine multiple concurrent cache fill\nrequests into a small number of requests to the origin.", +"description": "If true then Cloud CDN will combine multiple concurrent cache fill\nrequests into a small number of requests to the origin. If not specified,\nCloud CDN applies request coalescing by default.", "type": "boolean" }, "serveWhileStale": { @@ -61287,7 +61287,7 @@ false "id": "CachePolicyCacheKeyPolicy", "properties": { "excludedQueryParameters": { -"description": "Names of query string parameters to exclude in cache keys. All other\nparameters will be included. Either specify excluded_query_parameters or\nincluded_query_parameters, not both. '&' and '=' will be percent encoded\nand not treated as delimiters.\n\nNote: This field applies to routes that use backend services. Attempting\nto set it on a route that points exclusively to Backend Buckets will\nresult in a configuration error. For routes that point to a Backend\nBucket, use includedQueryParameters to define which parameters should\nbe a part of the cache key.", +"description": "Names of query string parameters to exclude in cache keys. All other\nparameters will be included. Either specify `excludedQueryParameters`\nor `includedQueryParameters`, not both. '&' and '=' will be percent\nencoded and not treated as delimiters.\n\nNote: This field applies to routes that use backend services. Attempting\nto set it on a route that points exclusively to Backend Buckets will\nresult in a configuration error. For routes that point to a Backend\nBucket, use `includedQueryParameters` to define which parameters should\nbe part of the cache key.", "items": { "type": "string" }, @@ -61302,7 +61302,7 @@ false "type": "boolean" }, "includeQueryString": { -"description": "If true, include query string parameters in the cache key according to\nincluded_query_parameters and excluded_query_parameters. If neither is\nset, the entire query string will be included. If false, the query string\nwill be excluded from the cache key entirely.\n\nNote: This field applies to routes that use backend services. Attempting\nto set it on a route that points exclusively to Backend Buckets will\nresult in a configuration error. For routes that point to a Backend\nBucket, use includedQueryParameters to define which parameters should\nbe a part of the cache key.", +"description": "If true, include query string parameters in the cache key according to\n`includedQueryParameters` and `excludedQueryParameters`. If neither\nis set, the entire query string will be included. If false, the query\nstring will be excluded from the cache key entirely.\n\nNote: This field applies to routes that use backend services. Attempting\nto set it on a route that points exclusively to Backend Buckets will\nresult in a configuration error. For routes that point to a Backend\nBucket, use `includedQueryParameters` to define which parameters should\nbe part of the cache key.", "type": "boolean" }, "includedCookieNames": { @@ -61320,7 +61320,7 @@ false "type": "array" }, "includedQueryParameters": { -"description": "Names of query string parameters to include in cache keys. All other\nparameters will be excluded. Either specify included_query_parameters or\nexcluded_query_parameters, not both. '&' and '=' will be percent encoded\nand not treated as delimiters.", +"description": "Names of query string parameters to include in cache keys. All other\nparameters will be excluded. Either specify `includedQueryParameters`\nor `excludedQueryParameters`, not both. '&' and '=' will be percent\nencoded and not treated as delimiters.", "items": { "type": "string" }, @@ -75020,7 +75020,7 @@ false "properties": { "cachePolicy": { "$ref": "CachePolicy", -"description": "Cache policy for this URL Map\u2019s route. Available only for Global\nEXTERNAL_MANAGED load balancer schemes." +"description": "Specifies the cache policy configuration for matched traffic. Available\nonly for Global `EXTERNAL_MANAGED` load balancer schemes. At least one\nproperty must be specified. This policy cannot be specified if any target\nbackend has Identity-Aware Proxy enabled." }, "corsPolicy": { "$ref": "CorsPolicy", diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index f978bd3e83..2eb268673b 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -51573,7 +51573,7 @@ } } }, -"revision": "20260331", +"revision": "20260410", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -57617,7 +57617,7 @@ false "id": "CachePolicy", "properties": { "cacheBypassRequestHeaderNames": { -"description": "Bypass the cache when the specified request headers are matched by name,\ne.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5\nheader names can be specified. The cache is bypassed for all\ncachePolicy.cacheMode settings.", +"description": "Bypass the cache when the specified request headers are matched by name,\ne.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5\nheader names can be specified. The cache is bypassed for all `cacheMode`\nvalues.", "items": { "type": "string" }, @@ -57625,10 +57625,10 @@ false }, "cacheKeyPolicy": { "$ref": "CachePolicyCacheKeyPolicy", -"description": "The CacheKeyPolicy for this CachePolicy." +"description": "The cache key configuration. If not specified, the default behavior depends\non the backend type: for Backend Services, the complete request URI is\nused; for Backend Buckets, the request URI is used without the protocol or\nhost, and only query parameters known to Cloud Storage are included." }, "cacheMode": { -"description": "Specifies the cache setting for all responses from this route.\nIf not specified, the default value is CACHE_ALL_STATIC.", +"description": "Specifies the cache setting for all responses from this route. If not\nspecified, Cloud CDN uses `CACHE_ALL_STATIC` mode.", "enum": [ "CACHE_ALL_STATIC", "FORCE_CACHE_ALL", @@ -57643,29 +57643,29 @@ false }, "clientTtl": { "$ref": "Duration", -"description": "Specifies a separate client (e.g. browser client) maximum TTL. This is\nused to clamp the max-age (or Expires) value sent to the client. With\nFORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the\nresponse max-age directive, along with a \"public\" directive. For\ncacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age\nfrom the origin (if specified), or else sets the response max-age\ndirective to the lesser of the client_ttl and default_ttl, and also\nensures a \"public\" cache-control directive is present.\nIf a client TTL is not specified, a default value (1 hour) will be used.\nThe maximum allowed value is 31,622,400s (1 year)." +"description": "Specifies a separate client (e.g. browser client) maximum TTL for cached\ncontent. This is used to clamp the max-age (or Expires) value sent to the\nclient. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl`\nis used for the response max-age directive, along with a \"public\"\ndirective. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl`\nclamps the max-age from the origin (if specified), or else sets the\nresponse max-age directive to the lesser of the `clientTtl` and\n`defaultTtl`, and also ensures a \"public\" cache-control directive is\npresent. The maximum allowed value is 31,622,400s (1 year). If not\nspecified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode.\nCannot exceed `maxTtl`. Cannot be specified when `cacheMode` is\n`USE_ORIGIN_HEADERS`." }, "defaultTtl": { "$ref": "Duration", -"description": "Specifies the default TTL for cached content served by this origin for\nresponses that do not have an existing valid TTL (max-age or s-maxage).\nSetting a TTL of \"0\" means \"always revalidate\".\nThe value of defaultTTL cannot be set to a value greater than that of\nmaxTTL.\nWhen the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL\nwill overwrite the TTL set in all responses. The maximum allowed value is\n31,622,400s (1 year). Infrequently accessed objects may be evicted from\nthe cache before the defined TTL." +"description": "Specifies the default TTL for cached content for responses that do not have\nan existing valid TTL (max-age or s-maxage). Setting a TTL of \"0\" means\n\"always revalidate\". The value of `defaultTtl` cannot be set to a value\ngreater than that of `maxTtl`. When the `cacheMode` is set to\n`FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all\nresponses. The maximum allowed value is 31,622,400s (1 year). Infrequently\naccessed objects may be evicted from the cache before the defined TTL. If\nnot specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and\n`FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is\n`USE_ORIGIN_HEADERS`." }, "maxTtl": { "$ref": "Duration", -"description": "Specifies the maximum allowed TTL for cached content served by this\norigin.\nCache directives that attempt to set a max-age or s-maxage higher than\nthis, or an Expires header more than maxTTL seconds in the future will\nbe capped at the value of maxTTL, as if it were the value of an\ns-maxage Cache-Control directive.\nHeaders sent to the client will not be modified.\nSetting a TTL of \"0\" means \"always revalidate\".\nThe maximum allowed value is 31,622,400s (1 year). Infrequently accessed\nobjects may be evicted from the cache before the defined TTL." +"description": "Specifies the maximum allowed TTL for cached content. Cache directives that\nattempt to set a max-age or s-maxage higher than this, or an Expires header\nmore than `maxTtl` seconds in the future will be capped at the value of\n`maxTtl`, as if it were the value of an s-maxage Cache-Control directive.\nHeaders sent to the client will not be modified. Setting a TTL of \"0\" means\n\"always revalidate\". The maximum allowed value is 31,622,400s (1 year).\nInfrequently accessed objects may be evicted from the cache before the\ndefined TTL. If not specified, Cloud CDN uses 86400s (1 day) for\n`CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache\nmode." }, "negativeCaching": { -"description": "Negative caching allows per-status code TTLs to be set, in order\nto apply fine-grained caching for common errors or redirects.\nThis can reduce the load on your origin and improve end-user\nexperience by reducing response latency.\nWhen the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,\nnegative caching applies to responses with the specified response code\nthat lack any Cache-Control, Expires, or Pragma: no-cache directives.\nWhen the cache mode is set to FORCE_CACHE_ALL, negative caching applies\nto all responses with the specified response code, and override any\ncaching headers.\nBy default, Cloud CDN will apply the following default TTLs to these\nstatus codes:\nHTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m\nHTTP 404 (Not Found), 410 (Gone),\n451 (Unavailable For Legal Reasons): 120s\nHTTP 405 (Method Not Found), 501 (Not Implemented): 60s.\nThese defaults can be overridden in negative_caching_policy.", +"description": "Negative caching allows per-status code TTLs to be set, in order\nto apply fine-grained caching for common errors or redirects.\nThis can reduce the load on your origin and improve end-user\nexperience by reducing response latency.\nWhen the `cacheMode` is set to `CACHE_ALL_STATIC` or\n`USE_ORIGIN_HEADERS`, negative caching applies to responses with\nthe specified response code that lack any Cache-Control, Expires, or\nPragma: no-cache directives. When the `cacheMode` is set to\n`FORCE_CACHE_ALL`, negative caching applies to all responses\nwith the specified response code, and overrides any caching headers. By\ndefault, Cloud CDN applies the following TTLs to these HTTP status codes:\n\n* 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m\n* 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s\n* 405 (Method Not Found), 501 (Not Implemented): 60s\n\nThese defaults can be overridden in `negativeCachingPolicy`.\nIf not specified, Cloud CDN applies negative caching by default.", "type": "boolean" }, "negativeCachingPolicy": { -"description": "Sets a cache TTL for the specified HTTP status code.\nnegative_caching must be enabled to configure negative_caching_policy.\nOmitting the policy and leaving negative_caching enabled will use\nCloud CDN's default cache TTLs.\nNote that when specifying an explicit negative_caching_policy, you\nshould take care to specify a cache TTL for all response codes\nthat you wish to cache. Cloud CDN will not apply any default\nnegative caching when a policy exists.", +"description": "Sets a cache TTL for the specified HTTP status code.\n`negativeCaching` must be enabled to configure `negativeCachingPolicy`.\nOmitting the policy and leaving `negativeCaching` enabled will use Cloud\nCDN's default cache TTLs. Note that when specifying an explicit\n`negativeCachingPolicy`, you should take care to specify a cache TTL for\nall response codes that you wish to cache. Cloud CDN will not apply any\ndefault negative caching when a policy exists.", "items": { "$ref": "CachePolicyNegativeCachingPolicy" }, "type": "array" }, "requestCoalescing": { -"description": "If true then Cloud CDN will combine multiple concurrent cache fill\nrequests into a small number of requests to the origin.", +"description": "If true then Cloud CDN will combine multiple concurrent cache fill\nrequests into a small number of requests to the origin. If not specified,\nCloud CDN applies request coalescing by default.", "type": "boolean" }, "serveWhileStale": { @@ -57680,7 +57680,7 @@ false "id": "CachePolicyCacheKeyPolicy", "properties": { "excludedQueryParameters": { -"description": "Names of query string parameters to exclude in cache keys. All other\nparameters will be included. Either specify excluded_query_parameters or\nincluded_query_parameters, not both. '&' and '=' will be percent encoded\nand not treated as delimiters.\n\nNote: This field applies to routes that use backend services. Attempting\nto set it on a route that points exclusively to Backend Buckets will\nresult in a configuration error. For routes that point to a Backend\nBucket, use includedQueryParameters to define which parameters should\nbe a part of the cache key.", +"description": "Names of query string parameters to exclude in cache keys. All other\nparameters will be included. Either specify `excludedQueryParameters`\nor `includedQueryParameters`, not both. '&' and '=' will be percent\nencoded and not treated as delimiters.\n\nNote: This field applies to routes that use backend services. Attempting\nto set it on a route that points exclusively to Backend Buckets will\nresult in a configuration error. For routes that point to a Backend\nBucket, use `includedQueryParameters` to define which parameters should\nbe part of the cache key.", "items": { "type": "string" }, @@ -57695,7 +57695,7 @@ false "type": "boolean" }, "includeQueryString": { -"description": "If true, include query string parameters in the cache key according to\nincluded_query_parameters and excluded_query_parameters. If neither is\nset, the entire query string will be included. If false, the query string\nwill be excluded from the cache key entirely.\n\nNote: This field applies to routes that use backend services. Attempting\nto set it on a route that points exclusively to Backend Buckets will\nresult in a configuration error. For routes that point to a Backend\nBucket, use includedQueryParameters to define which parameters should\nbe a part of the cache key.", +"description": "If true, include query string parameters in the cache key according to\n`includedQueryParameters` and `excludedQueryParameters`. If neither\nis set, the entire query string will be included. If false, the query\nstring will be excluded from the cache key entirely.\n\nNote: This field applies to routes that use backend services. Attempting\nto set it on a route that points exclusively to Backend Buckets will\nresult in a configuration error. For routes that point to a Backend\nBucket, use `includedQueryParameters` to define which parameters should\nbe part of the cache key.", "type": "boolean" }, "includedCookieNames": { @@ -57713,7 +57713,7 @@ false "type": "array" }, "includedQueryParameters": { -"description": "Names of query string parameters to include in cache keys. All other\nparameters will be excluded. Either specify included_query_parameters or\nexcluded_query_parameters, not both. '&' and '=' will be percent encoded\nand not treated as delimiters.", +"description": "Names of query string parameters to include in cache keys. All other\nparameters will be excluded. Either specify `includedQueryParameters`\nor `excludedQueryParameters`, not both. '&' and '=' will be percent\nencoded and not treated as delimiters.", "items": { "type": "string" }, @@ -68902,7 +68902,7 @@ false "properties": { "cachePolicy": { "$ref": "CachePolicy", -"description": "Cache policy for this URL Map\u2019s route. Available only for Global\nEXTERNAL_MANAGED load balancer schemes." +"description": "Specifies the cache policy configuration for matched traffic. Available\nonly for Global `EXTERNAL_MANAGED` load balancer schemes. At least one\nproperty must be specified. This policy cannot be specified if any target\nbackend has Identity-Aware Proxy enabled." }, "corsPolicy": { "$ref": "CorsPolicy", diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index b8323582be..b2c33e4145 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -47006,7 +47006,7 @@ } } }, -"revision": "20260331", +"revision": "20260410", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -52894,6 +52894,132 @@ false }, "type": "object" }, +"CachePolicy": { +"description": "Message containing CachePolicy configuration for URL Map's Route Action.", +"id": "CachePolicy", +"properties": { +"cacheBypassRequestHeaderNames": { +"description": "Bypass the cache when the specified request headers are matched by name,\ne.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5\nheader names can be specified. The cache is bypassed for all `cacheMode`\nvalues.", +"items": { +"type": "string" +}, +"type": "array" +}, +"cacheKeyPolicy": { +"$ref": "CachePolicyCacheKeyPolicy", +"description": "The cache key configuration. If not specified, the default behavior depends\non the backend type: for Backend Services, the complete request URI is\nused; for Backend Buckets, the request URI is used without the protocol or\nhost, and only query parameters known to Cloud Storage are included." +}, +"cacheMode": { +"description": "Specifies the cache setting for all responses from this route. If not\nspecified, Cloud CDN uses `CACHE_ALL_STATIC` mode.", +"enum": [ +"CACHE_ALL_STATIC", +"FORCE_CACHE_ALL", +"USE_ORIGIN_HEADERS" +], +"enumDescriptions": [ +"Automatically cache static content, including common image formats,\nmedia (video and audio), and web assets (JavaScript and CSS).\nRequests and responses that are marked as uncacheable, as well as\ndynamic content (including HTML), will not be cached.", +"Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\"\ndirectives in Cache-Control response headers.\nWarning: this may result in Cloud CDN caching private,\nper-user (user identifiable) content.", +"Requires the origin to set valid caching headers to cache content.\nResponses without these headers will not be cached at the edge, and will\nrequire a full trip to the origin on every request, potentially impacting\nperformance and increasing load on the origin server." +], +"type": "string" +}, +"clientTtl": { +"$ref": "Duration", +"description": "Specifies a separate client (e.g. browser client) maximum TTL for cached\ncontent. This is used to clamp the max-age (or Expires) value sent to the\nclient. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl`\nis used for the response max-age directive, along with a \"public\"\ndirective. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl`\nclamps the max-age from the origin (if specified), or else sets the\nresponse max-age directive to the lesser of the `clientTtl` and\n`defaultTtl`, and also ensures a \"public\" cache-control directive is\npresent. The maximum allowed value is 31,622,400s (1 year). If not\nspecified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode.\nCannot exceed `maxTtl`. Cannot be specified when `cacheMode` is\n`USE_ORIGIN_HEADERS`." +}, +"defaultTtl": { +"$ref": "Duration", +"description": "Specifies the default TTL for cached content for responses that do not have\nan existing valid TTL (max-age or s-maxage). Setting a TTL of \"0\" means\n\"always revalidate\". The value of `defaultTtl` cannot be set to a value\ngreater than that of `maxTtl`. When the `cacheMode` is set to\n`FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all\nresponses. The maximum allowed value is 31,622,400s (1 year). Infrequently\naccessed objects may be evicted from the cache before the defined TTL. If\nnot specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and\n`FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is\n`USE_ORIGIN_HEADERS`." +}, +"maxTtl": { +"$ref": "Duration", +"description": "Specifies the maximum allowed TTL for cached content. Cache directives that\nattempt to set a max-age or s-maxage higher than this, or an Expires header\nmore than `maxTtl` seconds in the future will be capped at the value of\n`maxTtl`, as if it were the value of an s-maxage Cache-Control directive.\nHeaders sent to the client will not be modified. Setting a TTL of \"0\" means\n\"always revalidate\". The maximum allowed value is 31,622,400s (1 year).\nInfrequently accessed objects may be evicted from the cache before the\ndefined TTL. If not specified, Cloud CDN uses 86400s (1 day) for\n`CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache\nmode." +}, +"negativeCaching": { +"description": "Negative caching allows per-status code TTLs to be set, in order\nto apply fine-grained caching for common errors or redirects.\nThis can reduce the load on your origin and improve end-user\nexperience by reducing response latency.\nWhen the `cacheMode` is set to `CACHE_ALL_STATIC` or\n`USE_ORIGIN_HEADERS`, negative caching applies to responses with\nthe specified response code that lack any Cache-Control, Expires, or\nPragma: no-cache directives. When the `cacheMode` is set to\n`FORCE_CACHE_ALL`, negative caching applies to all responses\nwith the specified response code, and overrides any caching headers. By\ndefault, Cloud CDN applies the following TTLs to these HTTP status codes:\n\n* 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m\n* 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s\n* 405 (Method Not Found), 501 (Not Implemented): 60s\n\nThese defaults can be overridden in `negativeCachingPolicy`.\nIf not specified, Cloud CDN applies negative caching by default.", +"type": "boolean" +}, +"negativeCachingPolicy": { +"description": "Sets a cache TTL for the specified HTTP status code.\n`negativeCaching` must be enabled to configure `negativeCachingPolicy`.\nOmitting the policy and leaving `negativeCaching` enabled will use Cloud\nCDN's default cache TTLs. Note that when specifying an explicit\n`negativeCachingPolicy`, you should take care to specify a cache TTL for\nall response codes that you wish to cache. Cloud CDN will not apply any\ndefault negative caching when a policy exists.", +"items": { +"$ref": "CachePolicyNegativeCachingPolicy" +}, +"type": "array" +}, +"requestCoalescing": { +"description": "If true then Cloud CDN will combine multiple concurrent cache fill\nrequests into a small number of requests to the origin. If not specified,\nCloud CDN applies request coalescing by default.", +"type": "boolean" +}, +"serveWhileStale": { +"$ref": "Duration", +"description": "Serve existing content from the cache (if available) when revalidating\ncontent with the origin, or when an error is encountered when refreshing\nthe cache.\nThis setting defines the default \"max-stale\" duration for any cached\nresponses that do not specify a max-stale directive. Stale responses that\nexceed the TTL configured here will not be served. The default limit\n(max-stale) is 86400s (1 day), which will allow stale content to be\nserved up to this limit beyond the max-age (or s-maxage) of a cached\nresponse.\nThe maximum allowed value is 604800 (1 week).\nSet this to zero (0) to disable serve-while-stale." +} +}, +"type": "object" +}, +"CachePolicyCacheKeyPolicy": { +"description": "Message containing what to include in the cache key for a request for Cache\nPolicy defined on Route Action.", +"id": "CachePolicyCacheKeyPolicy", +"properties": { +"excludedQueryParameters": { +"description": "Names of query string parameters to exclude in cache keys. All other\nparameters will be included. Either specify `excludedQueryParameters`\nor `includedQueryParameters`, not both. '&' and '=' will be percent\nencoded and not treated as delimiters.\n\nNote: This field applies to routes that use backend services. Attempting\nto set it on a route that points exclusively to Backend Buckets will\nresult in a configuration error. For routes that point to a Backend\nBucket, use `includedQueryParameters` to define which parameters should\nbe part of the cache key.", +"items": { +"type": "string" +}, +"type": "array" +}, +"includeHost": { +"description": "If true, requests to different hosts will be cached separately.\n\nNote: This setting is only applicable to routes that use a Backend\nService. It does not affect requests served by a Backend Bucket, as the\nhost is never included in a Backend Bucket's cache key. Attempting to set\nit on a route that points exclusively to Backend Buckets will result in a\nconfiguration error.", +"type": "boolean" +}, +"includeProtocol": { +"description": "If true, http and https requests will be cached separately.\n\nNote: This setting is only applicable to routes that use a Backend\nService. It does not affect requests served by a Backend Bucket, as the\nprotocol is never included in a Backend Bucket's cache key. Attempting to\nset on a route that points exclusively to Backend Buckets will result in\na configuration error.", +"type": "boolean" +}, +"includeQueryString": { +"description": "If true, include query string parameters in the cache key according to\n`includedQueryParameters` and `excludedQueryParameters`. If neither\nis set, the entire query string will be included. If false, the query\nstring will be excluded from the cache key entirely.\n\nNote: This field applies to routes that use backend services. Attempting\nto set it on a route that points exclusively to Backend Buckets will\nresult in a configuration error. For routes that point to a Backend\nBucket, use `includedQueryParameters` to define which parameters should\nbe part of the cache key.", +"type": "boolean" +}, +"includedCookieNames": { +"description": "Allows HTTP cookies (by name) to be used in the cache key.\nThe name=value pair will be used in the cache key Cloud CDN generates.\n\nNote: This setting is only applicable to routes that use a Backend\nService. It does not affect requests served by a Backend Bucket.\nAttempting to set it on a route that points exclusively to Backend\nBuckets will result in a configuration error. Up to 5 cookie names can be\nspecified.", +"items": { +"type": "string" +}, +"type": "array" +}, +"includedHeaderNames": { +"description": "Allows HTTP request headers (by name) to be used in the cache key.", +"items": { +"type": "string" +}, +"type": "array" +}, +"includedQueryParameters": { +"description": "Names of query string parameters to include in cache keys. All other\nparameters will be excluded. Either specify `includedQueryParameters`\nor `excludedQueryParameters`, not both. '&' and '=' will be percent\nencoded and not treated as delimiters.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"CachePolicyNegativeCachingPolicy": { +"description": "Specify CDN TTLs for response error codes.", +"id": "CachePolicyNegativeCachingPolicy", +"properties": { +"code": { +"description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be\nspecified as values, and you cannot specify a status code more than\nonce.", +"format": "int32", +"type": "integer" +}, +"ttl": { +"$ref": "Duration", +"description": "The TTL (in seconds) for which to cache responses with the\ncorresponding status code.\nThe maximum allowed value is 1800s (30 minutes). Infrequently accessed\nobjects may be evicted from the cache before the defined TTL." +} +}, +"type": "object" +}, "CalendarModeAdviceRequest": { "description": "A request to recommend the best way to consume the specified resources in the\nfuture.", "id": "CalendarModeAdviceRequest", @@ -63384,6 +63510,10 @@ false "HttpRouteAction": { "id": "HttpRouteAction", "properties": { +"cachePolicy": { +"$ref": "CachePolicy", +"description": "Specifies the cache policy configuration for matched traffic. Available\nonly for Global `EXTERNAL_MANAGED` load balancer schemes. At least one\nproperty must be specified. This policy cannot be specified if any target\nbackend has Identity-Aware Proxy enabled." +}, "corsPolicy": { "$ref": "CorsPolicy", "description": "The specification for allowing client-side cross-origin requests. For more\ninformation about the W3C recommendation for cross-origin resource sharing\n(CORS), see Fetch API Living\nStandard.\n\nNot supported when the URL map is bound to a target gRPC proxy." From ed6441b252f788d4763b62cd17ca5bfa0f589032 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:40:59 +0000 Subject: [PATCH 09/32] feat(container): update the api #### container:v1 The following keys were added: - schemas.AddonsConfig.properties.podSnapshotConfig.$ref (Total Keys: 1) - schemas.PodSnapshotConfig (Total Keys: 3) --- ...tainer_v1.projects.locations.clusters.html | 79 +++++++++++-------- ...projects.locations.clusters.nodePools.html | 66 ++++++++-------- .../container_v1.projects.zones.clusters.html | 79 +++++++++++-------- ..._v1.projects.zones.clusters.nodePools.html | 66 ++++++++-------- ...r_v1beta1.projects.locations.clusters.html | 64 +++++++-------- ...projects.locations.clusters.nodePools.html | 66 ++++++++-------- ...ainer_v1beta1.projects.zones.clusters.html | 64 +++++++-------- ...ta1.projects.zones.clusters.nodePools.html | 66 ++++++++-------- .../documents/container.v1.json | 47 +++++++---- .../documents/container.v1beta1.json | 32 ++++---- 10 files changed, 337 insertions(+), 292 deletions(-) diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index a5fd08ce33..099f73bbc2 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -318,6 +318,9 @@

Method Details

"parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, + "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Optional. Configuration for the Pod Snapshot feature. + "enabled": True or False, # Whether or not the Pod Snapshots feature is enabled. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray Operator addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies configuration of Ray logging. # Optional. Logging configuration for Ray clusters. @@ -740,7 +743,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -928,7 +931,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -1175,7 +1178,7 @@

Method Details

"gcfsConfig": { # GcfsConfig contains configurations of Google Container File System (image streaming). # GCFS (Google Container File System, also known as Riptide) options. "enabled": True or False, # Whether to use GCFS. }, - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration for node pools. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration for node pools. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -1239,13 +1242,13 @@

Method Details

}, "nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -1282,7 +1285,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -1470,7 +1473,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -1599,7 +1602,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -1607,7 +1610,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1617,7 +1620,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -2001,6 +2004,9 @@

Method Details

"parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, + "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Optional. Configuration for the Pod Snapshot feature. + "enabled": True or False, # Whether or not the Pod Snapshots feature is enabled. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray Operator addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies configuration of Ray logging. # Optional. Logging configuration for Ray clusters. @@ -2423,7 +2429,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -2611,7 +2617,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -2858,7 +2864,7 @@

Method Details

"gcfsConfig": { # GcfsConfig contains configurations of Google Container File System (image streaming). # GCFS (Google Container File System, also known as Riptide) options. "enabled": True or False, # Whether to use GCFS. }, - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration for node pools. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration for node pools. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -2922,13 +2928,13 @@

Method Details

}, "nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -2965,7 +2971,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -3153,7 +3159,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -3282,7 +3288,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -3290,7 +3296,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -3300,7 +3306,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -3548,6 +3554,9 @@

Method Details

"parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, + "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Optional. Configuration for the Pod Snapshot feature. + "enabled": True or False, # Whether or not the Pod Snapshots feature is enabled. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray Operator addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies configuration of Ray logging. # Optional. Logging configuration for Ray clusters. @@ -3970,7 +3979,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -4158,7 +4167,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -4405,7 +4414,7 @@

Method Details

"gcfsConfig": { # GcfsConfig contains configurations of Google Container File System (image streaming). # GCFS (Google Container File System, also known as Riptide) options. "enabled": True or False, # Whether to use GCFS. }, - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration for node pools. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration for node pools. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -4469,13 +4478,13 @@

Method Details

}, "nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -4512,7 +4521,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -4700,7 +4709,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -4829,7 +4838,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -4837,7 +4846,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -4847,7 +4856,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -5055,6 +5064,9 @@

Method Details

"parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, + "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Optional. Configuration for the Pod Snapshot feature. + "enabled": True or False, # Whether or not the Pod Snapshots feature is enabled. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray Operator addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies configuration of Ray logging. # Optional. Logging configuration for Ray clusters. @@ -5975,6 +5987,9 @@

Method Details

"parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, + "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Optional. Configuration for the Pod Snapshot feature. + "enabled": True or False, # Whether or not the Pod Snapshots feature is enabled. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray Operator addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies configuration of Ray logging. # Optional. Logging configuration for Ray clusters. @@ -6447,14 +6462,14 @@

Method Details

"desiredNodePoolAutoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. "totalMinNodeCount": 42, # Minimum number of nodes in the node pool. Must be greater than or equal to 0 and less than or equal to total_max_node_count. The total_*_node_count fields are mutually exclusive with the *_node_count fields. }, "desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster. - "desiredNodePoolLoggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # The desired node pool logging configuration defaults for the cluster. + "desiredNodePoolLoggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # The desired node pool logging configuration defaults for the cluster. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, diff --git a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html index ba9263551e..5516e02112 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html @@ -88,7 +88,7 @@

Instance Methods

Deletes a node pool from a cluster.

fetchNodePoolUpgradeInfo(name, version=None, x__xgafv=None)

-

Fetch upgrade information of a specific nodepool.

+

Fetch upgrade information of a specific node pool.

get(name, clusterId=None, nodePoolId=None, projectId=None, x__xgafv=None, zone=None)

Retrieves the requested node pool.

@@ -152,13 +152,13 @@

Method Details

{ # CreateNodePoolRequest creates a node pool for a cluster. "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. "nodePool": { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. # Required. The node pool to create. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -195,7 +195,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -383,7 +383,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -512,7 +512,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -520,7 +520,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -530,7 +530,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -705,10 +705,10 @@

Method Details

fetchNodePoolUpgradeInfo(name, version=None, x__xgafv=None) -
Fetch upgrade information of a specific nodepool.
+  
Fetch upgrade information of a specific node pool.
 
 Args:
-  name: string, Required. The name (project, location, cluster, nodepool) of the nodepool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`. (required)
+  name: string, Required. The name (project, location, cluster, node pool) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`. (required)
   version: string, API request version that initiates this operation.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -718,12 +718,12 @@ 

Method Details

Returns: An object of the form: - { # NodePoolUpgradeInfo contains the upgrade information of a nodepool. + { # NodePoolUpgradeInfo contains the upgrade information of a node pool. "autoUpgradeStatus": [ # The auto upgrade status. "A String", ], - "endOfExtendedSupportTimestamp": "A String", # The nodepool's current minor version's end of extended support timestamp. - "endOfStandardSupportTimestamp": "A String", # The nodepool's current minor version's end of standard support timestamp. + "endOfExtendedSupportTimestamp": "A String", # The node pool's current minor version's end of extended support timestamp. + "endOfStandardSupportTimestamp": "A String", # The node pool's current minor version's end of standard support timestamp. "minorTargetVersion": "A String", # minor_target_version indicates the target version for minor upgrade. "patchTargetVersion": "A String", # patch_target_version indicates the target version for patch upgrade. "pausedReason": [ # The auto upgrade paused reason. @@ -761,13 +761,13 @@

Method Details

An object of the form: { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -804,7 +804,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -992,7 +992,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -1121,7 +1121,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -1129,7 +1129,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1139,7 +1139,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -1197,13 +1197,13 @@

Method Details

{ # ListNodePoolsResponse is the result of ListNodePoolsRequest. "nodePools": [ # A list of node pools for a cluster. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -1240,7 +1240,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -1428,7 +1428,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -1557,7 +1557,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -1565,7 +1565,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1575,7 +1575,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -1707,7 +1707,7 @@

Method Details

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Required. Autoscaling configuration for the node pool. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -1970,7 +1970,7 @@

Method Details

}, }, ], - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The desired boot disk config for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified boot disk config. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The desired boot disk config for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified boot disk config. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -2150,7 +2150,7 @@

Method Details

"locations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. Warning: It is recommended to update node pool locations in a standalone API call. Do not combine a location update with changes to other fields (such as `tags`, `labels`, `taints`, etc.) in the same request. Otherwise, the API performs a structural modification where changes to other fields will only apply to newly created nodes and will not be applied to existing nodes in the node pool. To ensure all nodes are updated consistently, use a separate API call for location changes. "A String", ], - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -2158,7 +2158,7 @@

Method Details

"machineType": "A String", # Optional. The desired [Google Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "name": "A String", # The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # The desired node drain configuration for nodes in the node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # The desired node drain configuration for nodes in the node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config. @@ -2187,7 +2187,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -2199,7 +2199,7 @@

Method Details

"nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "resourceLabels": { # Collection of [Resource Manager labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "labels": { # Map of node label keys and node label values. diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index a5aa5b54a8..57611bccb4 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -195,6 +195,9 @@

Method Details

"parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, + "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Optional. Configuration for the Pod Snapshot feature. + "enabled": True or False, # Whether or not the Pod Snapshots feature is enabled. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray Operator addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies configuration of Ray logging. # Optional. Logging configuration for Ray clusters. @@ -420,6 +423,9 @@

Method Details

"parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, + "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Optional. Configuration for the Pod Snapshot feature. + "enabled": True or False, # Whether or not the Pod Snapshots feature is enabled. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray Operator addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies configuration of Ray logging. # Optional. Logging configuration for Ray clusters. @@ -842,7 +848,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -1030,7 +1036,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -1277,7 +1283,7 @@

Method Details

"gcfsConfig": { # GcfsConfig contains configurations of Google Container File System (image streaming). # GCFS (Google Container File System, also known as Riptide) options. "enabled": True or False, # Whether to use GCFS. }, - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration for node pools. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration for node pools. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -1341,13 +1347,13 @@

Method Details

}, "nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -1384,7 +1390,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -1572,7 +1578,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -1701,7 +1707,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -1709,7 +1715,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1719,7 +1725,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -2103,6 +2109,9 @@

Method Details

"parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, + "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Optional. Configuration for the Pod Snapshot feature. + "enabled": True or False, # Whether or not the Pod Snapshots feature is enabled. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray Operator addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies configuration of Ray logging. # Optional. Logging configuration for Ray clusters. @@ -2525,7 +2534,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -2713,7 +2722,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -2960,7 +2969,7 @@

Method Details

"gcfsConfig": { # GcfsConfig contains configurations of Google Container File System (image streaming). # GCFS (Google Container File System, also known as Riptide) options. "enabled": True or False, # Whether to use GCFS. }, - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration for node pools. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration for node pools. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -3024,13 +3033,13 @@

Method Details

}, "nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -3067,7 +3076,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -3255,7 +3264,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -3384,7 +3393,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -3392,7 +3401,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -3402,7 +3411,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -3694,6 +3703,9 @@

Method Details

"parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, + "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Optional. Configuration for the Pod Snapshot feature. + "enabled": True or False, # Whether or not the Pod Snapshots feature is enabled. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray Operator addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies configuration of Ray logging. # Optional. Logging configuration for Ray clusters. @@ -4116,7 +4128,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -4304,7 +4316,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -4551,7 +4563,7 @@

Method Details

"gcfsConfig": { # GcfsConfig contains configurations of Google Container File System (image streaming). # GCFS (Google Container File System, also known as Riptide) options. "enabled": True or False, # Whether to use GCFS. }, - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration for node pools. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration for node pools. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -4615,13 +4627,13 @@

Method Details

}, "nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -4658,7 +4670,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -4846,7 +4858,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -4975,7 +4987,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -4983,7 +4995,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -4993,7 +5005,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -6002,6 +6014,9 @@

Method Details

"parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver. "enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. }, + "podSnapshotConfig": { # PodSnapshotConfig is the configuration for GKE Pod Snapshots feature. # Optional. Configuration for the Pod Snapshot feature. + "enabled": True or False, # Whether or not the Pod Snapshots feature is enabled. + }, "rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon. "enabled": True or False, # Whether the Ray Operator addon is enabled for this cluster. "rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies configuration of Ray logging. # Optional. Logging configuration for Ray clusters. @@ -6474,14 +6489,14 @@

Method Details

"desiredNodePoolAutoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. "totalMinNodeCount": 42, # Minimum number of nodes in the node pool. Must be greater than or equal to 0 and less than or equal to total_max_node_count. The total_*_node_count fields are mutually exclusive with the *_node_count fields. }, "desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster. - "desiredNodePoolLoggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # The desired node pool logging configuration defaults for the cluster. + "desiredNodePoolLoggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # The desired node pool logging configuration defaults for the cluster. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, diff --git a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html index d6bdfc5370..1ffb5e2441 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html @@ -88,7 +88,7 @@

Instance Methods

Deletes a node pool from a cluster.

fetchNodePoolUpgradeInfo(name, version=None, x__xgafv=None)

-

Fetch upgrade information of a specific nodepool.

+

Fetch upgrade information of a specific node pool.

get(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)

Retrieves the requested node pool.

@@ -124,7 +124,7 @@

Method Details

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Required. Autoscaling configuration for the node pool. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -217,13 +217,13 @@

Method Details

{ # CreateNodePoolRequest creates a node pool for a cluster. "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. "nodePool": { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. # Required. The node pool to create. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -260,7 +260,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -448,7 +448,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -577,7 +577,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -585,7 +585,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -595,7 +595,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -770,10 +770,10 @@

Method Details

fetchNodePoolUpgradeInfo(name, version=None, x__xgafv=None) -
Fetch upgrade information of a specific nodepool.
+  
Fetch upgrade information of a specific node pool.
 
 Args:
-  name: string, Required. The name (project, location, cluster, nodepool) of the nodepool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`. (required)
+  name: string, Required. The name (project, location, cluster, node pool) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`. (required)
   version: string, API request version that initiates this operation.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -783,12 +783,12 @@ 

Method Details

Returns: An object of the form: - { # NodePoolUpgradeInfo contains the upgrade information of a nodepool. + { # NodePoolUpgradeInfo contains the upgrade information of a node pool. "autoUpgradeStatus": [ # The auto upgrade status. "A String", ], - "endOfExtendedSupportTimestamp": "A String", # The nodepool's current minor version's end of extended support timestamp. - "endOfStandardSupportTimestamp": "A String", # The nodepool's current minor version's end of standard support timestamp. + "endOfExtendedSupportTimestamp": "A String", # The node pool's current minor version's end of extended support timestamp. + "endOfStandardSupportTimestamp": "A String", # The node pool's current minor version's end of standard support timestamp. "minorTargetVersion": "A String", # minor_target_version indicates the target version for minor upgrade. "patchTargetVersion": "A String", # patch_target_version indicates the target version for patch upgrade. "pausedReason": [ # The auto upgrade paused reason. @@ -826,13 +826,13 @@

Method Details

An object of the form: { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -869,7 +869,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -1057,7 +1057,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -1186,7 +1186,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -1194,7 +1194,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1204,7 +1204,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -1262,13 +1262,13 @@

Method Details

{ # ListNodePoolsResponse is the result of ListNodePoolsRequest. "nodePools": [ # A list of node pools for a cluster. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -1305,7 +1305,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -1493,7 +1493,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -1622,7 +1622,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -1630,7 +1630,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1640,7 +1640,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -1960,7 +1960,7 @@

Method Details

}, }, ], - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The desired boot disk config for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified boot disk config. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The desired boot disk config for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified boot disk config. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -2140,7 +2140,7 @@

Method Details

"locations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. Warning: It is recommended to update node pool locations in a standalone API call. Do not combine a location update with changes to other fields (such as `tags`, `labels`, `taints`, etc.) in the same request. Otherwise, the API performs a structural modification where changes to other fields will only apply to newly created nodes and will not be applied to existing nodes in the node pool. To ensure all nodes are updated consistently, use a separate API call for location changes. "A String", ], - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -2148,7 +2148,7 @@

Method Details

"machineType": "A String", # Optional. The desired [Google Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "name": "A String", # The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # The desired node drain configuration for nodes in the node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # The desired node drain configuration for nodes in the node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config. @@ -2177,7 +2177,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -2189,7 +2189,7 @@

Method Details

"nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "resourceLabels": { # Collection of [Resource Manager labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "labels": { # Map of node label keys and node label values. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index 770f470c23..ecb4eaba95 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -851,7 +851,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # Boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # Boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -1050,7 +1050,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -1307,7 +1307,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration for node pools. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration for node pools. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -1371,13 +1371,13 @@

Method Details

}, "nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -1415,7 +1415,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # Boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # Boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -1614,7 +1614,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -1746,7 +1746,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -1754,7 +1754,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1764,7 +1764,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -2637,7 +2637,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # Boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # Boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -2836,7 +2836,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -3093,7 +3093,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration for node pools. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration for node pools. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -3157,13 +3157,13 @@

Method Details

}, "nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -3201,7 +3201,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # Boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # Boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -3400,7 +3400,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -3532,7 +3532,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -3540,7 +3540,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -3550,7 +3550,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -4280,7 +4280,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # Boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # Boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -4479,7 +4479,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -4736,7 +4736,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration for node pools. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration for node pools. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -4800,13 +4800,13 @@

Method Details

}, "nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -4844,7 +4844,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # Boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # Boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -5043,7 +5043,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -5175,7 +5175,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -5183,7 +5183,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -5193,7 +5193,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -6867,14 +6867,14 @@

Method Details

"desiredNodePoolAutoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. "totalMinNodeCount": 42, # Minimum number of nodes in the node pool. Must be greater than or equal to 0 and less than or equal to total_max_node_count. The total_*_node_count fields are mutually exclusive with the *_node_count fields. }, "desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family", "desired_node_pool_autoscaling", or "desired_workload_metadata_config" is specified and there is more than one node pool on the cluster. - "desiredNodePoolLoggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # The desired node pool logging configuration defaults for the cluster. + "desiredNodePoolLoggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # The desired node pool logging configuration defaults for the cluster. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html index e3ce44d34d..7c6088a669 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html @@ -88,7 +88,7 @@

Instance Methods

Deletes a node pool from a cluster.

fetchNodePoolUpgradeInfo(name, version=None, x__xgafv=None)

-

Fetch upgrade information of a specific nodepool.

+

Fetch upgrade information of a specific node pool.

get(name, clusterId=None, nodePoolId=None, projectId=None, x__xgafv=None, zone=None)

Retrieves the requested node pool.

@@ -152,13 +152,13 @@

Method Details

{ # CreateNodePoolRequest creates a node pool for a cluster. "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. "nodePool": { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. # Required. The node pool to create. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -196,7 +196,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # Boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # Boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -395,7 +395,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -527,7 +527,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -535,7 +535,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -545,7 +545,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -720,10 +720,10 @@

Method Details

fetchNodePoolUpgradeInfo(name, version=None, x__xgafv=None) -
Fetch upgrade information of a specific nodepool.
+  
Fetch upgrade information of a specific node pool.
 
 Args:
-  name: string, Required. The name (project, location, cluster, nodepool) of the nodepool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`. (required)
+  name: string, Required. The name (project, location, cluster, node pool) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`. (required)
   version: string, API request version that initiates this operation.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -733,12 +733,12 @@ 

Method Details

Returns: An object of the form: - { # NodePoolUpgradeInfo contains the upgrade information of a nodepool. + { # NodePoolUpgradeInfo contains the upgrade information of a node pool. "autoUpgradeStatus": [ # The auto upgrade status. "A String", ], - "endOfExtendedSupportTimestamp": "A String", # The nodepool's current minor version's end of extended support timestamp. - "endOfStandardSupportTimestamp": "A String", # The nodepool's current minor version's end of standard support timestamp. + "endOfExtendedSupportTimestamp": "A String", # The node pool's current minor version's end of extended support timestamp. + "endOfStandardSupportTimestamp": "A String", # The node pool's current minor version's end of standard support timestamp. "minorTargetVersion": "A String", # minor_target_version indicates the target version for minor upgrade. "patchTargetVersion": "A String", # patch_target_version indicates the target version for patch upgrade. "pausedReason": [ # The auto upgrade paused reason. @@ -778,13 +778,13 @@

Method Details

An object of the form: { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -822,7 +822,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # Boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # Boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -1021,7 +1021,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -1153,7 +1153,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -1161,7 +1161,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1171,7 +1171,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -1229,13 +1229,13 @@

Method Details

{ # ListNodePoolsResponse is the result of ListNodePoolsRequest. "nodePools": [ # A list of node pools for a cluster. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -1273,7 +1273,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # Boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # Boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -1472,7 +1472,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -1604,7 +1604,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -1612,7 +1612,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1622,7 +1622,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -1754,7 +1754,7 @@

Method Details

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Required. Autoscaling configuration for the node pool. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -2018,7 +2018,7 @@

Method Details

"maxTimeSharedClientsPerGpu": "A String", # The number of time-shared GPU resources to expose for each physical GPU. }, ], - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The desired boot disk config for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified boot disk config. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The desired boot disk config for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified boot disk config. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -2198,7 +2198,7 @@

Method Details

"locations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. Warning: It is recommended to update node pool locations in a standalone API call. Do not combine a location update with changes to other fields (such as `tags`, `labels`, `taints`, etc.) in the same request. Otherwise, the API performs a structural modification where changes to other fields will only apply to newly created nodes and will not be applied to existing nodes in the node pool. To ensure all nodes are updated consistently, use a separate API call for location changes. "A String", ], - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -2206,7 +2206,7 @@

Method Details

"machineType": "A String", # Optional. The desired machine type for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "name": "A String", # The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # The desired node drain configuration for nodes in the node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # The desired node drain configuration for nodes in the node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config. @@ -2236,7 +2236,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -2248,7 +2248,7 @@

Method Details

"nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "resourceLabels": { # Collection of [Resource Manager labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "labels": { # Map of node label keys and node label values. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index d8ad266497..351c4951be 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -966,7 +966,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # Boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # Boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -1165,7 +1165,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -1422,7 +1422,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration for node pools. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration for node pools. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -1486,13 +1486,13 @@

Method Details

}, "nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -1530,7 +1530,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # Boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # Boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -1729,7 +1729,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -1861,7 +1861,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -1869,7 +1869,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1879,7 +1879,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -2752,7 +2752,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # Boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # Boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -2951,7 +2951,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -3208,7 +3208,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration for node pools. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration for node pools. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -3272,13 +3272,13 @@

Method Details

}, "nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -3316,7 +3316,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # Boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # Boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -3515,7 +3515,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -3647,7 +3647,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -3655,7 +3655,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -3665,7 +3665,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -4439,7 +4439,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # Boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # Boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -4638,7 +4638,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -4895,7 +4895,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration for node pools. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration for node pools. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -4959,13 +4959,13 @@

Method Details

}, "nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -5003,7 +5003,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # Boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # Boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -5202,7 +5202,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -5334,7 +5334,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -5342,7 +5342,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -5352,7 +5352,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -6894,14 +6894,14 @@

Method Details

"desiredNodePoolAutoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. "totalMinNodeCount": 42, # Minimum number of nodes in the node pool. Must be greater than or equal to 0 and less than or equal to total_max_node_count. The total_*_node_count fields are mutually exclusive with the *_node_count fields. }, "desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family", "desired_node_pool_autoscaling", or "desired_workload_metadata_config" is specified and there is more than one node pool on the cluster. - "desiredNodePoolLoggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # The desired node pool logging configuration defaults for the cluster. + "desiredNodePoolLoggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # The desired node pool logging configuration defaults for the cluster. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html index 961635c953..2e710ce987 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html @@ -88,7 +88,7 @@

Instance Methods

Deletes a node pool from a cluster.

fetchNodePoolUpgradeInfo(name, version=None, x__xgafv=None)

-

Fetch upgrade information of a specific nodepool.

+

Fetch upgrade information of a specific node pool.

get(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)

Retrieves the requested node pool.

@@ -124,7 +124,7 @@

Method Details

"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Required. Autoscaling configuration for the node pool. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -217,13 +217,13 @@

Method Details

{ # CreateNodePoolRequest creates a node pool for a cluster. "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. "nodePool": { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. # Required. The node pool to create. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -261,7 +261,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # Boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # Boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -460,7 +460,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -592,7 +592,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -600,7 +600,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -610,7 +610,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -785,10 +785,10 @@

Method Details

fetchNodePoolUpgradeInfo(name, version=None, x__xgafv=None) -
Fetch upgrade information of a specific nodepool.
+  
Fetch upgrade information of a specific node pool.
 
 Args:
-  name: string, Required. The name (project, location, cluster, nodepool) of the nodepool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`. (required)
+  name: string, Required. The name (project, location, cluster, node pool) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`. (required)
   version: string, API request version that initiates this operation.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -798,12 +798,12 @@ 

Method Details

Returns: An object of the form: - { # NodePoolUpgradeInfo contains the upgrade information of a nodepool. + { # NodePoolUpgradeInfo contains the upgrade information of a node pool. "autoUpgradeStatus": [ # The auto upgrade status. "A String", ], - "endOfExtendedSupportTimestamp": "A String", # The nodepool's current minor version's end of extended support timestamp. - "endOfStandardSupportTimestamp": "A String", # The nodepool's current minor version's end of standard support timestamp. + "endOfExtendedSupportTimestamp": "A String", # The node pool's current minor version's end of extended support timestamp. + "endOfStandardSupportTimestamp": "A String", # The node pool's current minor version's end of standard support timestamp. "minorTargetVersion": "A String", # minor_target_version indicates the target version for minor upgrade. "patchTargetVersion": "A String", # patch_target_version indicates the target version for patch upgrade. "pausedReason": [ # The auto upgrade paused reason. @@ -843,13 +843,13 @@

Method Details

An object of the form: { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -887,7 +887,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # Boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # Boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -1086,7 +1086,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -1218,7 +1218,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -1226,7 +1226,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1236,7 +1236,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -1294,13 +1294,13 @@

Method Details

{ # ListNodePoolsResponse is the result of ListNodePoolsRequest. "nodePools": [ # A list of node pools for a cluster. { # NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this nodepool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. + "autopilotConfig": { # AutopilotConfig contains configuration of autopilot feature for this node pool. # Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. "enabled": True or False, # Denotes that nodes belonging to this node pool are Autopilot nodes. }, "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. "autoprovisioned": True or False, # Can this node pool be deleted automatically. "enabled": True or False, # Is autoscaling enabled for this node pool. - "locationPolicy": "A String", # Location policy used when scaling up a nodepool. + "locationPolicy": "A String", # Location policy used when scaling up a node pool. "maxNodeCount": 42, # Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. "minNodeCount": 42, # Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. "totalMaxNodeCount": 42, # Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. @@ -1338,7 +1338,7 @@

Method Details

"performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. "threadsPerCore": "A String", # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. }, - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # Boot disk configuration for the node pool. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # Boot disk configuration for the node pool. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -1537,7 +1537,7 @@

Method Details

}, "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -1669,7 +1669,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -1677,7 +1677,7 @@

Method Details

"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. "subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. }, - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # Specifies the node drain configuration for this node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1687,7 +1687,7 @@

Method Details

}, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "selfLink": "A String", # Output only. Server-defined URL for the resource. "status": "A String", # Output only. The status of the nodes in this pool instance. @@ -2008,7 +2008,7 @@

Method Details

"maxTimeSharedClientsPerGpu": "A String", # The number of time-shared GPU resources to expose for each physical GPU. }, ], - "bootDisk": { # BootDisk specifies the boot disk configuration for nodepools. # The desired boot disk config for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified boot disk config. + "bootDisk": { # BootDisk specifies the boot disk configuration for node pools. # The desired boot disk config for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified boot disk config. "diskType": "A String", # Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) "provisionedIops": "A String", # For Hyperdisk-Balanced only, the provisioned IOPS config value. "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. @@ -2188,7 +2188,7 @@

Method Details

"locations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. Warning: It is recommended to update node pool locations in a standalone API call. Do not combine a location update with changes to other fields (such as `tags`, `labels`, `taints`, etc.) in the same request. Otherwise, the API performs a structural modification where changes to other fields will only apply to newly created nodes and will not be applied to existing nodes in the node pool. To ensure all nodes are updated consistently, use a separate API call for location changes. "A String", ], - "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. + "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for node pools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, @@ -2196,7 +2196,7 @@

Method Details

"machineType": "A String", # Optional. The desired machine type for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "name": "A String", # The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. - "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this nodepool. # The desired node drain configuration for nodes in the node pool. + "nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # The desired node drain configuration for nodes in the node pool. "respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion. }, "nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config. @@ -2226,7 +2226,7 @@

Method Details

"networkTierConfig": { # NetworkTierConfig contains network tier information. # Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades. "networkTier": "A String", # Network tier configuration. }, - "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. + "podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled. "disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. @@ -2238,7 +2238,7 @@

Method Details

"nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. - "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. + "enabled": True or False, # Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, "resourceLabels": { # Collection of [Resource Manager labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "labels": { # Map of node label keys and node label values. diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index a10e299181..6d41a067ab 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -902,7 +902,7 @@ ] }, "fetchNodePoolUpgradeInfo": { -"description": "Fetch upgrade information of a specific nodepool.", +"description": "Fetch upgrade information of a specific node pool.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:fetchNodePoolUpgradeInfo", "httpMethod": "GET", "id": "container.projects.locations.clusters.nodePools.fetchNodePoolUpgradeInfo", @@ -911,7 +911,7 @@ ], "parameters": { "name": { -"description": "Required. The name (project, location, cluster, nodepool) of the nodepool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`.", +"description": "Required. The name (project, location, cluster, node pool) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, @@ -2213,7 +2213,7 @@ ] }, "fetchNodePoolUpgradeInfo": { -"description": "Fetch upgrade information of a specific nodepool.", +"description": "Fetch upgrade information of a specific node pool.", "flatPath": "v1/projects/{projectsId}/zones/{zonesId}/clusters/{clustersId}/nodePools/{nodePoolsId}:fetchNodePoolUpgradeInfo", "httpMethod": "GET", "id": "container.projects.zones.clusters.nodePools.fetchNodePoolUpgradeInfo", @@ -2222,7 +2222,7 @@ ], "parameters": { "name": { -"description": "Required. The name (project, location, cluster, nodepool) of the nodepool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`.", +"description": "Required. The name (project, location, cluster, node pool) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`.", "location": "path", "pattern": "^projects/[^/]+/zones/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, @@ -2660,7 +2660,7 @@ } } }, -"revision": "20260324", +"revision": "20260331", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2855,6 +2855,10 @@ "$ref": "ParallelstoreCsiDriverConfig", "description": "Configuration for the Cloud Storage Parallelstore CSI driver." }, +"podSnapshotConfig": { +"$ref": "PodSnapshotConfig", +"description": "Optional. Configuration for the Pod Snapshot feature." +}, "rayOperatorConfig": { "$ref": "RayOperatorConfig", "description": "Optional. Configuration for Ray Operator addon." @@ -3089,7 +3093,7 @@ "type": "object" }, "AutopilotConfig": { -"description": "AutopilotConfig contains configuration of autopilot feature for this nodepool.", +"description": "AutopilotConfig contains configuration of autopilot feature for this node pool.", "id": "AutopilotConfig", "properties": { "enabled": { @@ -3294,7 +3298,7 @@ "type": "object" }, "BootDisk": { -"description": "BootDisk specifies the boot disk configuration for nodepools.", +"description": "BootDisk specifies the boot disk configuration for node pools.", "id": "BootDisk", "properties": { "diskType": { @@ -6985,7 +6989,7 @@ false "type": "object" }, "NodeDrainConfig": { -"description": "NodeDrainConfig contains the node drain related configurations for this nodepool.", +"description": "NodeDrainConfig contains the node drain related configurations for this node pool.", "id": "NodeDrainConfig", "properties": { "respectPdbDuringNodePoolDeletion": { @@ -7200,7 +7204,7 @@ false }, "podCidrOverprovisionConfig": { "$ref": "PodCIDROverprovisionConfig", -"description": "[PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled." +"description": "[PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled." }, "podIpv4CidrBlock": { "description": "The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.", @@ -7395,7 +7399,7 @@ false "type": "boolean" }, "locationPolicy": { -"description": "Location policy used when scaling up a nodepool.", +"description": "Location policy used when scaling up a node pool.", "enum": [ "LOCATION_POLICY_UNSPECIFIED", "BALANCED", @@ -7443,7 +7447,7 @@ false "type": "object" }, "NodePoolLoggingConfig": { -"description": "NodePoolLoggingConfig specifies logging configuration for nodepools.", +"description": "NodePoolLoggingConfig specifies logging configuration for node pools.", "id": "NodePoolLoggingConfig", "properties": { "variantConfig": { @@ -7454,7 +7458,7 @@ false "type": "object" }, "NodePoolUpgradeInfo": { -"description": "NodePoolUpgradeInfo contains the upgrade information of a nodepool.", +"description": "NodePoolUpgradeInfo contains the upgrade information of a node pool.", "id": "NodePoolUpgradeInfo", "properties": { "autoUpgradeStatus": { @@ -7477,11 +7481,11 @@ false "type": "array" }, "endOfExtendedSupportTimestamp": { -"description": "The nodepool's current minor version's end of extended support timestamp.", +"description": "The node pool's current minor version's end of extended support timestamp.", "type": "string" }, "endOfStandardSupportTimestamp": { -"description": "The nodepool's current minor version's end of standard support timestamp.", +"description": "The node pool's current minor version's end of standard support timestamp.", "type": "string" }, "minorTargetVersion": { @@ -7911,6 +7915,17 @@ false }, "type": "object" }, +"PodSnapshotConfig": { +"description": "PodSnapshotConfig is the configuration for GKE Pod Snapshots feature.", +"id": "PodSnapshotConfig", +"properties": { +"enabled": { +"description": "Whether or not the Pod Snapshots feature is enabled.", +"type": "boolean" +} +}, +"type": "object" +}, "PrivateClusterConfig": { "description": "Configuration options for private clusters.", "id": "PrivateClusterConfig", @@ -8026,7 +8041,7 @@ false "id": "QueuedProvisioning", "properties": { "enabled": { -"description": "Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API.", +"description": "Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API.", "type": "boolean" } }, @@ -9866,7 +9881,7 @@ false "Default value if unset. GKE internally defaults the update strategy to SURGE for unspecified strategies.", "blue-green upgrade.", "SURGE is the traditional way of upgrade a node pool. max_surge and max_unavailable determines the level of upgrade parallelism.", -"SHORT_LIVED is the dedicated upgrade strategy for QueuedProvisioning and flex start nodepools scaled up only by enqueueing to the Dynamic Workload Scheduler (DWS)." +"SHORT_LIVED is the dedicated upgrade strategy for QueuedProvisioning and flex start node pools scaled up only by enqueueing to the Dynamic Workload Scheduler (DWS)." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index 1b910619c4..a8c8a9a8a0 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -955,7 +955,7 @@ ] }, "fetchNodePoolUpgradeInfo": { -"description": "Fetch upgrade information of a specific nodepool.", +"description": "Fetch upgrade information of a specific node pool.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:fetchNodePoolUpgradeInfo", "httpMethod": "GET", "id": "container.projects.locations.clusters.nodePools.fetchNodePoolUpgradeInfo", @@ -964,7 +964,7 @@ ], "parameters": { "name": { -"description": "Required. The name (project, location, cluster, nodepool) of the nodepool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`.", +"description": "Required. The name (project, location, cluster, node pool) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, @@ -2294,7 +2294,7 @@ ] }, "fetchNodePoolUpgradeInfo": { -"description": "Fetch upgrade information of a specific nodepool.", +"description": "Fetch upgrade information of a specific node pool.", "flatPath": "v1beta1/projects/{projectsId}/zones/{zonesId}/clusters/{clustersId}/nodePools/{nodePoolsId}:fetchNodePoolUpgradeInfo", "httpMethod": "GET", "id": "container.projects.zones.clusters.nodePools.fetchNodePoolUpgradeInfo", @@ -2303,7 +2303,7 @@ ], "parameters": { "name": { -"description": "Required. The name (project, location, cluster, nodepool) of the nodepool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`.", +"description": "Required. The name (project, location, cluster, node pool) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*` or `projects/*/zones/*/clusters/*/nodePools/*`.", "location": "path", "pattern": "^projects/[^/]+/zones/[^/]+/clusters/[^/]+/nodePools/[^/]+$", "required": true, @@ -2741,7 +2741,7 @@ } } }, -"revision": "20260323", +"revision": "20260331", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3210,7 +3210,7 @@ "type": "object" }, "AutopilotConfig": { -"description": "AutopilotConfig contains configuration of autopilot feature for this nodepool.", +"description": "AutopilotConfig contains configuration of autopilot feature for this node pool.", "id": "AutopilotConfig", "properties": { "enabled": { @@ -3464,7 +3464,7 @@ "type": "object" }, "BootDisk": { -"description": "BootDisk specifies the boot disk configuration for nodepools.", +"description": "BootDisk specifies the boot disk configuration for node pools.", "id": "BootDisk", "properties": { "diskType": { @@ -7510,7 +7510,7 @@ false "type": "object" }, "NodeDrainConfig": { -"description": "NodeDrainConfig contains the node drain related configurations for this nodepool.", +"description": "NodeDrainConfig contains the node drain related configurations for this node pool.", "id": "NodeDrainConfig", "properties": { "respectPdbDuringNodePoolDeletion": { @@ -7725,7 +7725,7 @@ false }, "podCidrOverprovisionConfig": { "$ref": "PodCIDROverprovisionConfig", -"description": "[PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled." +"description": "[PRIVATE FIELD] Pod CIDR size overprovisioning config for the node pool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled." }, "podIpv4CidrBlock": { "description": "The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.", @@ -7920,7 +7920,7 @@ false "type": "boolean" }, "locationPolicy": { -"description": "Location policy used when scaling up a nodepool.", +"description": "Location policy used when scaling up a node pool.", "enum": [ "LOCATION_POLICY_UNSPECIFIED", "BALANCED", @@ -7968,7 +7968,7 @@ false "type": "object" }, "NodePoolLoggingConfig": { -"description": "NodePoolLoggingConfig specifies logging configuration for nodepools.", +"description": "NodePoolLoggingConfig specifies logging configuration for node pools.", "id": "NodePoolLoggingConfig", "properties": { "variantConfig": { @@ -7979,7 +7979,7 @@ false "type": "object" }, "NodePoolUpgradeInfo": { -"description": "NodePoolUpgradeInfo contains the upgrade information of a nodepool.", +"description": "NodePoolUpgradeInfo contains the upgrade information of a node pool.", "id": "NodePoolUpgradeInfo", "properties": { "autoUpgradeStatus": { @@ -8002,11 +8002,11 @@ false "type": "array" }, "endOfExtendedSupportTimestamp": { -"description": "The nodepool's current minor version's end of extended support timestamp.", +"description": "The node pool's current minor version's end of extended support timestamp.", "type": "string" }, "endOfStandardSupportTimestamp": { -"description": "The nodepool's current minor version's end of standard support timestamp.", +"description": "The node pool's current minor version's end of standard support timestamp.", "type": "string" }, "minorTargetVersion": { @@ -8631,7 +8631,7 @@ false "id": "QueuedProvisioning", "properties": { "enabled": { -"description": "Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API.", +"description": "Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API.", "type": "boolean" } }, @@ -10579,7 +10579,7 @@ false "Default value if unset. GKE internally defaults the update strategy to SURGE for unspecified strategies.", "blue-green upgrade.", "SURGE is the traditional way of upgrading a node pool. max_surge and max_unavailable determines the level of upgrade parallelism.", -"SHORT_LIVED is the dedicated upgrade strategy for QueuedProvisioning and flex start nodepools scaled up only by enqueueing to the Dynamic Workload Scheduler (DWS)." +"SHORT_LIVED is the dedicated upgrade strategy for QueuedProvisioning and flex start node pools scaled up only by enqueueing to the Dynamic Workload Scheduler (DWS)." ], "type": "string" } From 45079533085c9963c75191b4ec4cbd5e92c99d5b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:40:59 +0000 Subject: [PATCH 10/32] feat(dataflow): update the api #### dataflow:v1b3 The following keys were added: - schemas.RuntimeUpdatableParams.properties.autoscalingTier.deprecated (Total Keys: 1) - schemas.RuntimeUpdatableParams.properties.latencyTier.type (Total Keys: 1) --- docs/dyn/dataflow_v1b3.projects.jobs.html | 35 +++++++++++-------- ...v1b3.projects.locations.flexTemplates.html | 9 ++--- ...dataflow_v1b3.projects.locations.jobs.html | 30 +++++++++------- ...low_v1b3.projects.locations.templates.html | 10 +++--- .../dyn/dataflow_v1b3.projects.templates.html | 10 +++--- .../documents/dataflow.v1b3.json | 11 ++++-- 6 files changed, 64 insertions(+), 41 deletions(-) diff --git a/docs/dyn/dataflow_v1b3.projects.jobs.html b/docs/dyn/dataflow_v1b3.projects.jobs.html index a821a883fc..bb2f55a175 100644 --- a/docs/dyn/dataflow_v1b3.projects.jobs.html +++ b/docs/dyn/dataflow_v1b3.projects.jobs.html @@ -452,8 +452,9 @@

Method Details

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. "requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests. "runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation. - "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. - "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. + "autoscalingTier": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "latencyTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". "maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. "minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. "workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). @@ -819,8 +820,9 @@

Method Details

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. "requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests. "runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation. - "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. - "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. + "autoscalingTier": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "latencyTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". "maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. "minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. "workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). @@ -1170,8 +1172,9 @@

Method Details

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. "requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests. "runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation. - "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. - "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. + "autoscalingTier": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "latencyTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". "maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. "minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. "workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). @@ -1528,8 +1531,9 @@

Method Details

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. "requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests. "runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation. - "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. - "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. + "autoscalingTier": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "latencyTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". "maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. "minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. "workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). @@ -1946,8 +1950,9 @@

Method Details

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. "requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests. "runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation. - "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. - "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. + "autoscalingTier": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "latencyTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". "maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. "minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. "workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). @@ -2354,8 +2359,9 @@

Method Details

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. "requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests. "runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation. - "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. - "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. + "autoscalingTier": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "latencyTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". "maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. "minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. "workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). @@ -2699,8 +2705,9 @@

Method Details

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. "requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests. "runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation. - "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. - "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. + "autoscalingTier": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "latencyTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". "maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. "minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. "workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). diff --git a/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html b/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html index 3ae321c66c..3d00c5734c 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html @@ -117,7 +117,7 @@

Method Details

"flexrsGoal": "A String", # Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs "ipConfiguration": "A String", # Configuration for VM IPs. "kmsKeyName": "A String", # Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ - "launcherMachineType": "A String", # The machine type to use for launching the job. The default is n1-standard-1. + "launcherMachineType": "A String", # The machine type to use for launching the job. If not set, Dataflow will select a default machine type. "machineType": "A String", # The machine type to use for the job. Defaults to the value from the template if not specified. "maxWorkers": 42, # The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". @@ -199,7 +199,7 @@

Method Details

"flexrsGoal": "A String", # Set FlexRS goal for the job. https://cloud.google.com/dataflow/docs/guides/flexrs "ipConfiguration": "A String", # Configuration for VM IPs. "kmsKeyName": "A String", # Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ - "launcherMachineType": "A String", # The machine type to use for launching the job. The default is n1-standard-1. + "launcherMachineType": "A String", # The machine type to use for launching the job. If not set, Dataflow will select a default machine type. "machineType": "A String", # The machine type to use for the job. Defaults to the value from the template if not specified. "maxWorkers": 42, # The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". @@ -534,8 +534,9 @@

Method Details

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. "requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests. "runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation. - "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. - "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. + "autoscalingTier": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "latencyTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". "maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. "minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. "workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). diff --git a/docs/dyn/dataflow_v1b3.projects.locations.jobs.html b/docs/dyn/dataflow_v1b3.projects.locations.jobs.html index 015e43de62..ab94031405 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.jobs.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.jobs.html @@ -440,8 +440,9 @@

Method Details

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. "requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests. "runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation. - "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. - "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. + "autoscalingTier": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "latencyTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". "maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. "minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. "workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). @@ -790,8 +791,9 @@

Method Details

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. "requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests. "runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation. - "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. - "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. + "autoscalingTier": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "latencyTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". "maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. "minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. "workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). @@ -1148,8 +1150,9 @@

Method Details

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. "requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests. "runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation. - "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. - "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. + "autoscalingTier": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "latencyTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". "maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. "minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. "workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). @@ -1676,8 +1679,9 @@

Method Details

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. "requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests. "runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation. - "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. - "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. + "autoscalingTier": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "latencyTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". "maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. "minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. "workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). @@ -2086,8 +2090,9 @@

Method Details

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. "requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests. "runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation. - "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. - "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. + "autoscalingTier": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "latencyTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". "maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. "minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. "workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). @@ -2430,8 +2435,9 @@

Method Details

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. "requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests. "runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation. - "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. - "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. + "autoscalingTier": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "latencyTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". "maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. "minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. "workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). diff --git a/docs/dyn/dataflow_v1b3.projects.locations.templates.html b/docs/dyn/dataflow_v1b3.projects.locations.templates.html index ff21ad63f0..766c59626d 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.templates.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.templates.html @@ -441,8 +441,9 @@

Method Details

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. "requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests. "runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation. - "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. - "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. + "autoscalingTier": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "latencyTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". "maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. "minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. "workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). @@ -944,8 +945,9 @@

Method Details

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. "requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests. "runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation. - "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. - "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. + "autoscalingTier": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "latencyTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". "maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. "minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. "workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). diff --git a/docs/dyn/dataflow_v1b3.projects.templates.html b/docs/dyn/dataflow_v1b3.projects.templates.html index e921a1cfee..f8c1870982 100644 --- a/docs/dyn/dataflow_v1b3.projects.templates.html +++ b/docs/dyn/dataflow_v1b3.projects.templates.html @@ -440,8 +440,9 @@

Method Details

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. "requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests. "runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation. - "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. - "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. + "autoscalingTier": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "latencyTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". "maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. "minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. "workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). @@ -943,8 +944,9 @@

Method Details

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. "requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests. "runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation. - "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. - "autoscalingTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "acceptableBacklogDuration": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative. + "autoscalingTier": "A String", # Optional. Deprecated: Use `latency_tier` instead. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". + "latencyTier": "A String", # Optional. The backlog threshold tier for autoscaling. Value must be one of "low-latency", "medium-latency", or "high-latency". "maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs. "minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs. "workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog. For more information, see [Update an existing pipeline](https://cloud.google.com/dataflow/docs/guides/updating-a-pipeline). diff --git a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json index cc7ef452e1..bc84b27169 100644 --- a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json +++ b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json @@ -2400,7 +2400,7 @@ } } }, -"revision": "20260213", +"revision": "20260405", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -3796,7 +3796,7 @@ "type": "string" }, "launcherMachineType": { -"description": "The machine type to use for launching the job. The default is n1-standard-1.", +"description": "The machine type to use for launching the job. If not set, Dataflow will select a default machine type.", "type": "string" }, "machineType": { @@ -5982,11 +5982,16 @@ false "properties": { "acceptableBacklogDuration": { "deprecated": true, -"description": "Optional. Deprecated: Use `autoscaling_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.", +"description": "Optional. Deprecated: Use `latency_tier` instead. The backlog threshold duration in seconds for autoscaling. Value must be non-negative.", "format": "google-duration", "type": "string" }, "autoscalingTier": { +"deprecated": true, +"description": "Optional. Deprecated: Use `latency_tier` instead. The backlog threshold tier for autoscaling. Value must be one of \"low-latency\", \"medium-latency\", or \"high-latency\".", +"type": "string" +}, +"latencyTier": { "description": "Optional. The backlog threshold tier for autoscaling. Value must be one of \"low-latency\", \"medium-latency\", or \"high-latency\".", "type": "string" }, From 0eca0c1b51ddca3d2a0f4581a9ada8e4f0a3b133 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:40:59 +0000 Subject: [PATCH 11/32] feat(dataplex): update the api #### dataplex:v1 The following keys were added: - resources.projects.resources.locations.resources.dataScans.resources.jobs.methods.cancel (Total Keys: 12) - schemas.GoogleCloudDataplexV1CancelDataScanJobRequest (Total Keys: 2) - schemas.GoogleCloudDataplexV1CancelDataScanJobResponse (Total Keys: 2) - schemas.GoogleCloudDataplexV1DataQualityRule.properties.attributes (Total Keys: 2) - schemas.GoogleCloudDataplexV1DataQualityRule.properties.ruleSource (Total Keys: 2) - schemas.GoogleCloudDataplexV1DataQualityRule.properties.templateReference.$ref (Total Keys: 1) - schemas.GoogleCloudDataplexV1DataQualityRuleRuleSource (Total Keys: 25) - schemas.GoogleCloudDataplexV1DataQualityRuleTemplate (Total Keys: 31) - schemas.GoogleCloudDataplexV1DataQualitySpec.properties.enableCatalogBasedRules.type (Total Keys: 1) - schemas.GoogleCloudDataplexV1DataQualitySpec.properties.filter.type (Total Keys: 1) --- ...aplex_v1.projects.locations.dataScans.html | 505 ++++++++++++++++++ ..._v1.projects.locations.dataScans.jobs.html | 256 +++++++++ .../documents/dataplex.v1.json | 253 ++++++++- 3 files changed, 1011 insertions(+), 3 deletions(-) diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.html index 593c93139d..190f778b5a 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.html @@ -389,6 +389,9 @@

Method Details

"passed": True or False, # Output only. Whether the rule passed or failed. "passedCount": "A String", # Output only. The number of rows which passed a rule evaluation.This field is only valid for row-level type rules.This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is. + "attributes": { # Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field. + "a_key": "A String", + }, "column": "A String", # Optional. The unnested column which this rule is evaluated against. "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} @@ -414,6 +417,21 @@

Method Details

"rowConditionExpectation": { # Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 # Row-level rule which evaluates whether each row in a table passes the specified condition. "sqlExpression": "A String", # Optional. The SQL expression. }, + "ruleSource": { # Represents the rule source information from Catalog. # Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable. + "rulePathElements": [ # Output only. Rule path elements represent information about the individual items in the relationship path between the scan resource and rule origin in that order. + { # Path Element represents the direct relationship between the rule origin (aspects) to the BigQuery Entry. Ordering of the rule relationship will be maintained such that the first entry in the list is the closest ancestor (BigQuery table itself). A blank source denotes that the rule is derived directly from the DataScan itself. + "entryLinkSource": { # Entry link source represents information about the entry link. # Output only. Entry link source represents information about the entry link. + "entryLink": "A String", # Output only. The entry link name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "entryLinkType": "A String", # Output only. The entry link type to represent the current relationship between the entry and the next entry in the path. In the form of: projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id} + }, + "entrySource": { # Entry source represents information about the related source entry. # Output only. Entry source represents information about the related source entry. + "displayName": "A String", # Output only. The display name of the entry. + "entry": "A String", # Output only. The entry name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "entryType": "A String", # Output only. The entry type to represent the current characteristics of the entry in the form of: projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry-type-id}. + }, + }, + ], + }, "setExpectation": { # Evaluates whether each column value is contained by a specified set. # Row-level rule which evaluates whether each column value is contained by a specified set. "values": [ # Optional. Expected values for the column value. "A String", @@ -433,6 +451,33 @@

Method Details

"tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, + "templateReference": { # A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails # Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails. + "name": "A String", # Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "resolvedSql": "A String", # Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result. + "ruleTemplate": { # DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules. # Output only. The rule template used to resolve the rule. It is only populated in the result. + "capabilities": [ # Output only. A list of features or properties supported by this rule template. + "A String", + ], + "dimension": "A String", # Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level. + "inputParameters": { # Output only. Description for input parameters + "a_key": { # Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + "defaultValue": "A String", # Output only. The default value for the parameter if no value is provided. + "description": "A String", # Output only. Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + }, + }, + "name": "A String", # Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "sqlCollection": [ # Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported. + { # Templatized SQL query for data quality rules. It can have parameters that can be substituted with values when a rule is created using this template. + "query": "A String", # Output only. Templatized SQL query for data quality rules. + }, + ], + }, + "values": { # Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": { # Represents a parameter value. + "value": "A String", # Required. Represents the string value of the parameter. + }, + }, + }, "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for row-level type rules. "uniquenessExpectation": { # Evaluates whether the column has duplicates. # Row-level rule which evaluates whether each column value is unique. }, @@ -450,6 +495,8 @@

Method Details

}, "dataQualitySpec": { # DataQualityScan related setting. # Settings for a data quality scan. "catalogPublishingEnabled": True or False, # Optional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata. + "enableCatalogBasedRules": True or False, # Optional. If enabled, the data scan will retrieve rules defined in the dataplex-types.global.data-rules aspect on all paths of the catalog entry corresponding to the BigQuery table resource and all attached glossary terms. The path that data-rules aspect is attached on the table entry defines the column that the rule will be evaluated against. For glossary terms, the path that the terms are attached on the table entry defines the column that the rule will be evaluated against. At the start of scan execution, the rules reflect the latest state retrieved from the catalog entry and any updates on the rules thereafter are ignored for that execution. The updates will be reflected from the next execution. Rules defined in the datascan must be empty if this field is enabled. + "filter": "A String", # Optional. Filter for selectively running a subset of rules. You can filter the request by the name or attribute key-value pairs defined on the rule. If not specified, all rules are run. The filter is applicable to both, the rules retrieved from catalog and explicitly defined rules in the scan. Please see filter syntax (https://docs.cloud.google.com/dataplex/docs/auto-data-quality-overview#rule-filtering) for more details. "postScanActions": { # The configuration of post scan actions of DataQualityScan. # 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 DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -472,6 +519,9 @@

Method Details

"rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).Example: col1 >= 0 AND col2 < 10 "rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. { # A rule captures data quality intent about a data source. + "attributes": { # Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field. + "a_key": "A String", + }, "column": "A String", # Optional. The unnested column which this rule is evaluated against. "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} @@ -497,6 +547,21 @@

Method Details

"rowConditionExpectation": { # Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 # Row-level rule which evaluates whether each row in a table passes the specified condition. "sqlExpression": "A String", # Optional. The SQL expression. }, + "ruleSource": { # Represents the rule source information from Catalog. # Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable. + "rulePathElements": [ # Output only. Rule path elements represent information about the individual items in the relationship path between the scan resource and rule origin in that order. + { # Path Element represents the direct relationship between the rule origin (aspects) to the BigQuery Entry. Ordering of the rule relationship will be maintained such that the first entry in the list is the closest ancestor (BigQuery table itself). A blank source denotes that the rule is derived directly from the DataScan itself. + "entryLinkSource": { # Entry link source represents information about the entry link. # Output only. Entry link source represents information about the entry link. + "entryLink": "A String", # Output only. The entry link name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "entryLinkType": "A String", # Output only. The entry link type to represent the current relationship between the entry and the next entry in the path. In the form of: projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id} + }, + "entrySource": { # Entry source represents information about the related source entry. # Output only. Entry source represents information about the related source entry. + "displayName": "A String", # Output only. The display name of the entry. + "entry": "A String", # Output only. The entry name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "entryType": "A String", # Output only. The entry type to represent the current characteristics of the entry in the form of: projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry-type-id}. + }, + }, + ], + }, "setExpectation": { # Evaluates whether each column value is contained by a specified set. # Row-level rule which evaluates whether each column value is contained by a specified set. "values": [ # Optional. Expected values for the column value. "A String", @@ -516,6 +581,33 @@

Method Details

"tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, + "templateReference": { # A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails # Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails. + "name": "A String", # Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "resolvedSql": "A String", # Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result. + "ruleTemplate": { # DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules. # Output only. The rule template used to resolve the rule. It is only populated in the result. + "capabilities": [ # Output only. A list of features or properties supported by this rule template. + "A String", + ], + "dimension": "A String", # Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level. + "inputParameters": { # Output only. Description for input parameters + "a_key": { # Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + "defaultValue": "A String", # Output only. The default value for the parameter if no value is provided. + "description": "A String", # Output only. Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + }, + }, + "name": "A String", # Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "sqlCollection": [ # Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported. + { # Templatized SQL query for data quality rules. It can have parameters that can be substituted with values when a rule is created using this template. + "query": "A String", # Output only. Templatized SQL query for data quality rules. + }, + ], + }, + "values": { # Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": { # Represents a parameter value. + "value": "A String", # Required. Represents the string value of the parameter. + }, + }, + }, "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for row-level type rules. "uniquenessExpectation": { # Evaluates whether the column has duplicates. # Row-level rule which evaluates whether each column value is unique. }, @@ -652,6 +744,9 @@

Method Details

{ # Response details for data quality rule recommendations. "rule": [ # The data quality rules that Dataplex Universal Catalog generates based on the results of a data profiling scan. { # A rule captures data quality intent about a data source. + "attributes": { # Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field. + "a_key": "A String", + }, "column": "A String", # Optional. The unnested column which this rule is evaluated against. "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} @@ -677,6 +772,21 @@

Method Details

"rowConditionExpectation": { # Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 # Row-level rule which evaluates whether each row in a table passes the specified condition. "sqlExpression": "A String", # Optional. The SQL expression. }, + "ruleSource": { # Represents the rule source information from Catalog. # Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable. + "rulePathElements": [ # Output only. Rule path elements represent information about the individual items in the relationship path between the scan resource and rule origin in that order. + { # Path Element represents the direct relationship between the rule origin (aspects) to the BigQuery Entry. Ordering of the rule relationship will be maintained such that the first entry in the list is the closest ancestor (BigQuery table itself). A blank source denotes that the rule is derived directly from the DataScan itself. + "entryLinkSource": { # Entry link source represents information about the entry link. # Output only. Entry link source represents information about the entry link. + "entryLink": "A String", # Output only. The entry link name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "entryLinkType": "A String", # Output only. The entry link type to represent the current relationship between the entry and the next entry in the path. In the form of: projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id} + }, + "entrySource": { # Entry source represents information about the related source entry. # Output only. Entry source represents information about the related source entry. + "displayName": "A String", # Output only. The display name of the entry. + "entry": "A String", # Output only. The entry name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "entryType": "A String", # Output only. The entry type to represent the current characteristics of the entry in the form of: projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry-type-id}. + }, + }, + ], + }, "setExpectation": { # Evaluates whether each column value is contained by a specified set. # Row-level rule which evaluates whether each column value is contained by a specified set. "values": [ # Optional. Expected values for the column value. "A String", @@ -696,6 +806,33 @@

Method Details

"tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, + "templateReference": { # A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails # Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails. + "name": "A String", # Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "resolvedSql": "A String", # Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result. + "ruleTemplate": { # DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules. # Output only. The rule template used to resolve the rule. It is only populated in the result. + "capabilities": [ # Output only. A list of features or properties supported by this rule template. + "A String", + ], + "dimension": "A String", # Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level. + "inputParameters": { # Output only. Description for input parameters + "a_key": { # Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + "defaultValue": "A String", # Output only. The default value for the parameter if no value is provided. + "description": "A String", # Output only. Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + }, + }, + "name": "A String", # Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "sqlCollection": [ # Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported. + { # Templatized SQL query for data quality rules. It can have parameters that can be substituted with values when a rule is created using this template. + "query": "A String", # Output only. Templatized SQL query for data quality rules. + }, + ], + }, + "values": { # Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": { # Represents a parameter value. + "value": "A String", # Required. Represents the string value of the parameter. + }, + }, + }, "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for row-level type rules. "uniquenessExpectation": { # Evaluates whether the column has duplicates. # Row-level rule which evaluates whether each column value is unique. }, @@ -982,6 +1119,9 @@

Method Details

"passed": True or False, # Output only. Whether the rule passed or failed. "passedCount": "A String", # Output only. The number of rows which passed a rule evaluation.This field is only valid for row-level type rules.This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is. + "attributes": { # Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field. + "a_key": "A String", + }, "column": "A String", # Optional. The unnested column which this rule is evaluated against. "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} @@ -1007,6 +1147,21 @@

Method Details

"rowConditionExpectation": { # Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 # Row-level rule which evaluates whether each row in a table passes the specified condition. "sqlExpression": "A String", # Optional. The SQL expression. }, + "ruleSource": { # Represents the rule source information from Catalog. # Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable. + "rulePathElements": [ # Output only. Rule path elements represent information about the individual items in the relationship path between the scan resource and rule origin in that order. + { # Path Element represents the direct relationship between the rule origin (aspects) to the BigQuery Entry. Ordering of the rule relationship will be maintained such that the first entry in the list is the closest ancestor (BigQuery table itself). A blank source denotes that the rule is derived directly from the DataScan itself. + "entryLinkSource": { # Entry link source represents information about the entry link. # Output only. Entry link source represents information about the entry link. + "entryLink": "A String", # Output only. The entry link name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "entryLinkType": "A String", # Output only. The entry link type to represent the current relationship between the entry and the next entry in the path. In the form of: projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id} + }, + "entrySource": { # Entry source represents information about the related source entry. # Output only. Entry source represents information about the related source entry. + "displayName": "A String", # Output only. The display name of the entry. + "entry": "A String", # Output only. The entry name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "entryType": "A String", # Output only. The entry type to represent the current characteristics of the entry in the form of: projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry-type-id}. + }, + }, + ], + }, "setExpectation": { # Evaluates whether each column value is contained by a specified set. # Row-level rule which evaluates whether each column value is contained by a specified set. "values": [ # Optional. Expected values for the column value. "A String", @@ -1026,6 +1181,33 @@

Method Details

"tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, + "templateReference": { # A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails # Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails. + "name": "A String", # Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "resolvedSql": "A String", # Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result. + "ruleTemplate": { # DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules. # Output only. The rule template used to resolve the rule. It is only populated in the result. + "capabilities": [ # Output only. A list of features or properties supported by this rule template. + "A String", + ], + "dimension": "A String", # Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level. + "inputParameters": { # Output only. Description for input parameters + "a_key": { # Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + "defaultValue": "A String", # Output only. The default value for the parameter if no value is provided. + "description": "A String", # Output only. Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + }, + }, + "name": "A String", # Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "sqlCollection": [ # Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported. + { # Templatized SQL query for data quality rules. It can have parameters that can be substituted with values when a rule is created using this template. + "query": "A String", # Output only. Templatized SQL query for data quality rules. + }, + ], + }, + "values": { # Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": { # Represents a parameter value. + "value": "A String", # Required. Represents the string value of the parameter. + }, + }, + }, "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for row-level type rules. "uniquenessExpectation": { # Evaluates whether the column has duplicates. # Row-level rule which evaluates whether each column value is unique. }, @@ -1043,6 +1225,8 @@

Method Details

}, "dataQualitySpec": { # DataQualityScan related setting. # Settings for a data quality scan. "catalogPublishingEnabled": True or False, # Optional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata. + "enableCatalogBasedRules": True or False, # Optional. If enabled, the data scan will retrieve rules defined in the dataplex-types.global.data-rules aspect on all paths of the catalog entry corresponding to the BigQuery table resource and all attached glossary terms. The path that data-rules aspect is attached on the table entry defines the column that the rule will be evaluated against. For glossary terms, the path that the terms are attached on the table entry defines the column that the rule will be evaluated against. At the start of scan execution, the rules reflect the latest state retrieved from the catalog entry and any updates on the rules thereafter are ignored for that execution. The updates will be reflected from the next execution. Rules defined in the datascan must be empty if this field is enabled. + "filter": "A String", # Optional. Filter for selectively running a subset of rules. You can filter the request by the name or attribute key-value pairs defined on the rule. If not specified, all rules are run. The filter is applicable to both, the rules retrieved from catalog and explicitly defined rules in the scan. Please see filter syntax (https://docs.cloud.google.com/dataplex/docs/auto-data-quality-overview#rule-filtering) for more details. "postScanActions": { # The configuration of post scan actions of DataQualityScan. # 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 DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -1065,6 +1249,9 @@

Method Details

"rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).Example: col1 >= 0 AND col2 < 10 "rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. { # A rule captures data quality intent about a data source. + "attributes": { # Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field. + "a_key": "A String", + }, "column": "A String", # Optional. The unnested column which this rule is evaluated against. "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} @@ -1090,6 +1277,21 @@

Method Details

"rowConditionExpectation": { # Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 # Row-level rule which evaluates whether each row in a table passes the specified condition. "sqlExpression": "A String", # Optional. The SQL expression. }, + "ruleSource": { # Represents the rule source information from Catalog. # Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable. + "rulePathElements": [ # Output only. Rule path elements represent information about the individual items in the relationship path between the scan resource and rule origin in that order. + { # Path Element represents the direct relationship between the rule origin (aspects) to the BigQuery Entry. Ordering of the rule relationship will be maintained such that the first entry in the list is the closest ancestor (BigQuery table itself). A blank source denotes that the rule is derived directly from the DataScan itself. + "entryLinkSource": { # Entry link source represents information about the entry link. # Output only. Entry link source represents information about the entry link. + "entryLink": "A String", # Output only. The entry link name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "entryLinkType": "A String", # Output only. The entry link type to represent the current relationship between the entry and the next entry in the path. In the form of: projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id} + }, + "entrySource": { # Entry source represents information about the related source entry. # Output only. Entry source represents information about the related source entry. + "displayName": "A String", # Output only. The display name of the entry. + "entry": "A String", # Output only. The entry name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "entryType": "A String", # Output only. The entry type to represent the current characteristics of the entry in the form of: projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry-type-id}. + }, + }, + ], + }, "setExpectation": { # Evaluates whether each column value is contained by a specified set. # Row-level rule which evaluates whether each column value is contained by a specified set. "values": [ # Optional. Expected values for the column value. "A String", @@ -1109,6 +1311,33 @@

Method Details

"tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, + "templateReference": { # A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails # Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails. + "name": "A String", # Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "resolvedSql": "A String", # Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result. + "ruleTemplate": { # DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules. # Output only. The rule template used to resolve the rule. It is only populated in the result. + "capabilities": [ # Output only. A list of features or properties supported by this rule template. + "A String", + ], + "dimension": "A String", # Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level. + "inputParameters": { # Output only. Description for input parameters + "a_key": { # Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + "defaultValue": "A String", # Output only. The default value for the parameter if no value is provided. + "description": "A String", # Output only. Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + }, + }, + "name": "A String", # Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "sqlCollection": [ # Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported. + { # Templatized SQL query for data quality rules. It can have parameters that can be substituted with values when a rule is created using this template. + "query": "A String", # Output only. Templatized SQL query for data quality rules. + }, + ], + }, + "values": { # Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": { # Represents a parameter value. + "value": "A String", # Required. Represents the string value of the parameter. + }, + }, + }, "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for row-level type rules. "uniquenessExpectation": { # Evaluates whether the column has duplicates. # Row-level rule which evaluates whether each column value is unique. }, @@ -1483,6 +1712,9 @@

Method Details

"passed": True or False, # Output only. Whether the rule passed or failed. "passedCount": "A String", # Output only. The number of rows which passed a rule evaluation.This field is only valid for row-level type rules.This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is. + "attributes": { # Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field. + "a_key": "A String", + }, "column": "A String", # Optional. The unnested column which this rule is evaluated against. "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} @@ -1508,6 +1740,21 @@

Method Details

"rowConditionExpectation": { # Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 # Row-level rule which evaluates whether each row in a table passes the specified condition. "sqlExpression": "A String", # Optional. The SQL expression. }, + "ruleSource": { # Represents the rule source information from Catalog. # Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable. + "rulePathElements": [ # Output only. Rule path elements represent information about the individual items in the relationship path between the scan resource and rule origin in that order. + { # Path Element represents the direct relationship between the rule origin (aspects) to the BigQuery Entry. Ordering of the rule relationship will be maintained such that the first entry in the list is the closest ancestor (BigQuery table itself). A blank source denotes that the rule is derived directly from the DataScan itself. + "entryLinkSource": { # Entry link source represents information about the entry link. # Output only. Entry link source represents information about the entry link. + "entryLink": "A String", # Output only. The entry link name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "entryLinkType": "A String", # Output only. The entry link type to represent the current relationship between the entry and the next entry in the path. In the form of: projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id} + }, + "entrySource": { # Entry source represents information about the related source entry. # Output only. Entry source represents information about the related source entry. + "displayName": "A String", # Output only. The display name of the entry. + "entry": "A String", # Output only. The entry name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "entryType": "A String", # Output only. The entry type to represent the current characteristics of the entry in the form of: projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry-type-id}. + }, + }, + ], + }, "setExpectation": { # Evaluates whether each column value is contained by a specified set. # Row-level rule which evaluates whether each column value is contained by a specified set. "values": [ # Optional. Expected values for the column value. "A String", @@ -1527,6 +1774,33 @@

Method Details

"tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, + "templateReference": { # A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails # Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails. + "name": "A String", # Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "resolvedSql": "A String", # Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result. + "ruleTemplate": { # DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules. # Output only. The rule template used to resolve the rule. It is only populated in the result. + "capabilities": [ # Output only. A list of features or properties supported by this rule template. + "A String", + ], + "dimension": "A String", # Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level. + "inputParameters": { # Output only. Description for input parameters + "a_key": { # Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + "defaultValue": "A String", # Output only. The default value for the parameter if no value is provided. + "description": "A String", # Output only. Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + }, + }, + "name": "A String", # Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "sqlCollection": [ # Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported. + { # Templatized SQL query for data quality rules. It can have parameters that can be substituted with values when a rule is created using this template. + "query": "A String", # Output only. Templatized SQL query for data quality rules. + }, + ], + }, + "values": { # Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": { # Represents a parameter value. + "value": "A String", # Required. Represents the string value of the parameter. + }, + }, + }, "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for row-level type rules. "uniquenessExpectation": { # Evaluates whether the column has duplicates. # Row-level rule which evaluates whether each column value is unique. }, @@ -1544,6 +1818,8 @@

Method Details

}, "dataQualitySpec": { # DataQualityScan related setting. # Settings for a data quality scan. "catalogPublishingEnabled": True or False, # Optional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata. + "enableCatalogBasedRules": True or False, # Optional. If enabled, the data scan will retrieve rules defined in the dataplex-types.global.data-rules aspect on all paths of the catalog entry corresponding to the BigQuery table resource and all attached glossary terms. The path that data-rules aspect is attached on the table entry defines the column that the rule will be evaluated against. For glossary terms, the path that the terms are attached on the table entry defines the column that the rule will be evaluated against. At the start of scan execution, the rules reflect the latest state retrieved from the catalog entry and any updates on the rules thereafter are ignored for that execution. The updates will be reflected from the next execution. Rules defined in the datascan must be empty if this field is enabled. + "filter": "A String", # Optional. Filter for selectively running a subset of rules. You can filter the request by the name or attribute key-value pairs defined on the rule. If not specified, all rules are run. The filter is applicable to both, the rules retrieved from catalog and explicitly defined rules in the scan. Please see filter syntax (https://docs.cloud.google.com/dataplex/docs/auto-data-quality-overview#rule-filtering) for more details. "postScanActions": { # The configuration of post scan actions of DataQualityScan. # 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 DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -1566,6 +1842,9 @@

Method Details

"rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).Example: col1 >= 0 AND col2 < 10 "rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. { # A rule captures data quality intent about a data source. + "attributes": { # Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field. + "a_key": "A String", + }, "column": "A String", # Optional. The unnested column which this rule is evaluated against. "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} @@ -1591,6 +1870,21 @@

Method Details

"rowConditionExpectation": { # Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 # Row-level rule which evaluates whether each row in a table passes the specified condition. "sqlExpression": "A String", # Optional. The SQL expression. }, + "ruleSource": { # Represents the rule source information from Catalog. # Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable. + "rulePathElements": [ # Output only. Rule path elements represent information about the individual items in the relationship path between the scan resource and rule origin in that order. + { # Path Element represents the direct relationship between the rule origin (aspects) to the BigQuery Entry. Ordering of the rule relationship will be maintained such that the first entry in the list is the closest ancestor (BigQuery table itself). A blank source denotes that the rule is derived directly from the DataScan itself. + "entryLinkSource": { # Entry link source represents information about the entry link. # Output only. Entry link source represents information about the entry link. + "entryLink": "A String", # Output only. The entry link name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "entryLinkType": "A String", # Output only. The entry link type to represent the current relationship between the entry and the next entry in the path. In the form of: projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id} + }, + "entrySource": { # Entry source represents information about the related source entry. # Output only. Entry source represents information about the related source entry. + "displayName": "A String", # Output only. The display name of the entry. + "entry": "A String", # Output only. The entry name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "entryType": "A String", # Output only. The entry type to represent the current characteristics of the entry in the form of: projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry-type-id}. + }, + }, + ], + }, "setExpectation": { # Evaluates whether each column value is contained by a specified set. # Row-level rule which evaluates whether each column value is contained by a specified set. "values": [ # Optional. Expected values for the column value. "A String", @@ -1610,6 +1904,33 @@

Method Details

"tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, + "templateReference": { # A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails # Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails. + "name": "A String", # Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "resolvedSql": "A String", # Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result. + "ruleTemplate": { # DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules. # Output only. The rule template used to resolve the rule. It is only populated in the result. + "capabilities": [ # Output only. A list of features or properties supported by this rule template. + "A String", + ], + "dimension": "A String", # Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level. + "inputParameters": { # Output only. Description for input parameters + "a_key": { # Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + "defaultValue": "A String", # Output only. The default value for the parameter if no value is provided. + "description": "A String", # Output only. Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + }, + }, + "name": "A String", # Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "sqlCollection": [ # Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported. + { # Templatized SQL query for data quality rules. It can have parameters that can be substituted with values when a rule is created using this template. + "query": "A String", # Output only. Templatized SQL query for data quality rules. + }, + ], + }, + "values": { # Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": { # Represents a parameter value. + "value": "A String", # Required. Represents the string value of the parameter. + }, + }, + }, "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for row-level type rules. "uniquenessExpectation": { # Evaluates whether the column has duplicates. # Row-level rule which evaluates whether each column value is unique. }, @@ -1945,6 +2266,9 @@

Method Details

"passed": True or False, # Output only. Whether the rule passed or failed. "passedCount": "A String", # Output only. The number of rows which passed a rule evaluation.This field is only valid for row-level type rules.This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is. + "attributes": { # Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field. + "a_key": "A String", + }, "column": "A String", # Optional. The unnested column which this rule is evaluated against. "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} @@ -1970,6 +2294,21 @@

Method Details

"rowConditionExpectation": { # Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 # Row-level rule which evaluates whether each row in a table passes the specified condition. "sqlExpression": "A String", # Optional. The SQL expression. }, + "ruleSource": { # Represents the rule source information from Catalog. # Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable. + "rulePathElements": [ # Output only. Rule path elements represent information about the individual items in the relationship path between the scan resource and rule origin in that order. + { # Path Element represents the direct relationship between the rule origin (aspects) to the BigQuery Entry. Ordering of the rule relationship will be maintained such that the first entry in the list is the closest ancestor (BigQuery table itself). A blank source denotes that the rule is derived directly from the DataScan itself. + "entryLinkSource": { # Entry link source represents information about the entry link. # Output only. Entry link source represents information about the entry link. + "entryLink": "A String", # Output only. The entry link name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "entryLinkType": "A String", # Output only. The entry link type to represent the current relationship between the entry and the next entry in the path. In the form of: projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id} + }, + "entrySource": { # Entry source represents information about the related source entry. # Output only. Entry source represents information about the related source entry. + "displayName": "A String", # Output only. The display name of the entry. + "entry": "A String", # Output only. The entry name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "entryType": "A String", # Output only. The entry type to represent the current characteristics of the entry in the form of: projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry-type-id}. + }, + }, + ], + }, "setExpectation": { # Evaluates whether each column value is contained by a specified set. # Row-level rule which evaluates whether each column value is contained by a specified set. "values": [ # Optional. Expected values for the column value. "A String", @@ -1989,6 +2328,33 @@

Method Details

"tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, + "templateReference": { # A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails # Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails. + "name": "A String", # Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "resolvedSql": "A String", # Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result. + "ruleTemplate": { # DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules. # Output only. The rule template used to resolve the rule. It is only populated in the result. + "capabilities": [ # Output only. A list of features or properties supported by this rule template. + "A String", + ], + "dimension": "A String", # Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level. + "inputParameters": { # Output only. Description for input parameters + "a_key": { # Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + "defaultValue": "A String", # Output only. The default value for the parameter if no value is provided. + "description": "A String", # Output only. Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + }, + }, + "name": "A String", # Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "sqlCollection": [ # Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported. + { # Templatized SQL query for data quality rules. It can have parameters that can be substituted with values when a rule is created using this template. + "query": "A String", # Output only. Templatized SQL query for data quality rules. + }, + ], + }, + "values": { # Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": { # Represents a parameter value. + "value": "A String", # Required. Represents the string value of the parameter. + }, + }, + }, "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for row-level type rules. "uniquenessExpectation": { # Evaluates whether the column has duplicates. # Row-level rule which evaluates whether each column value is unique. }, @@ -2006,6 +2372,8 @@

Method Details

}, "dataQualitySpec": { # DataQualityScan related setting. # Settings for a data quality scan. "catalogPublishingEnabled": True or False, # Optional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata. + "enableCatalogBasedRules": True or False, # Optional. If enabled, the data scan will retrieve rules defined in the dataplex-types.global.data-rules aspect on all paths of the catalog entry corresponding to the BigQuery table resource and all attached glossary terms. The path that data-rules aspect is attached on the table entry defines the column that the rule will be evaluated against. For glossary terms, the path that the terms are attached on the table entry defines the column that the rule will be evaluated against. At the start of scan execution, the rules reflect the latest state retrieved from the catalog entry and any updates on the rules thereafter are ignored for that execution. The updates will be reflected from the next execution. Rules defined in the datascan must be empty if this field is enabled. + "filter": "A String", # Optional. Filter for selectively running a subset of rules. You can filter the request by the name or attribute key-value pairs defined on the rule. If not specified, all rules are run. The filter is applicable to both, the rules retrieved from catalog and explicitly defined rules in the scan. Please see filter syntax (https://docs.cloud.google.com/dataplex/docs/auto-data-quality-overview#rule-filtering) for more details. "postScanActions": { # The configuration of post scan actions of DataQualityScan. # 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 DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -2028,6 +2396,9 @@

Method Details

"rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).Example: col1 >= 0 AND col2 < 10 "rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. { # A rule captures data quality intent about a data source. + "attributes": { # Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field. + "a_key": "A String", + }, "column": "A String", # Optional. The unnested column which this rule is evaluated against. "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} @@ -2053,6 +2424,21 @@

Method Details

"rowConditionExpectation": { # Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 # Row-level rule which evaluates whether each row in a table passes the specified condition. "sqlExpression": "A String", # Optional. The SQL expression. }, + "ruleSource": { # Represents the rule source information from Catalog. # Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable. + "rulePathElements": [ # Output only. Rule path elements represent information about the individual items in the relationship path between the scan resource and rule origin in that order. + { # Path Element represents the direct relationship between the rule origin (aspects) to the BigQuery Entry. Ordering of the rule relationship will be maintained such that the first entry in the list is the closest ancestor (BigQuery table itself). A blank source denotes that the rule is derived directly from the DataScan itself. + "entryLinkSource": { # Entry link source represents information about the entry link. # Output only. Entry link source represents information about the entry link. + "entryLink": "A String", # Output only. The entry link name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "entryLinkType": "A String", # Output only. The entry link type to represent the current relationship between the entry and the next entry in the path. In the form of: projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id} + }, + "entrySource": { # Entry source represents information about the related source entry. # Output only. Entry source represents information about the related source entry. + "displayName": "A String", # Output only. The display name of the entry. + "entry": "A String", # Output only. The entry name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "entryType": "A String", # Output only. The entry type to represent the current characteristics of the entry in the form of: projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry-type-id}. + }, + }, + ], + }, "setExpectation": { # Evaluates whether each column value is contained by a specified set. # Row-level rule which evaluates whether each column value is contained by a specified set. "values": [ # Optional. Expected values for the column value. "A String", @@ -2072,6 +2458,33 @@

Method Details

"tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, + "templateReference": { # A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails # Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails. + "name": "A String", # Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "resolvedSql": "A String", # Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result. + "ruleTemplate": { # DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules. # Output only. The rule template used to resolve the rule. It is only populated in the result. + "capabilities": [ # Output only. A list of features or properties supported by this rule template. + "A String", + ], + "dimension": "A String", # Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level. + "inputParameters": { # Output only. Description for input parameters + "a_key": { # Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + "defaultValue": "A String", # Output only. The default value for the parameter if no value is provided. + "description": "A String", # Output only. Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + }, + }, + "name": "A String", # Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "sqlCollection": [ # Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported. + { # Templatized SQL query for data quality rules. It can have parameters that can be substituted with values when a rule is created using this template. + "query": "A String", # Output only. Templatized SQL query for data quality rules. + }, + ], + }, + "values": { # Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": { # Represents a parameter value. + "value": "A String", # Required. Represents the string value of the parameter. + }, + }, + }, "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for row-level type rules. "uniquenessExpectation": { # Evaluates whether the column has duplicates. # Row-level rule which evaluates whether each column value is unique. }, @@ -2425,6 +2838,9 @@

Method Details

"passed": True or False, # Output only. Whether the rule passed or failed. "passedCount": "A String", # Output only. The number of rows which passed a rule evaluation.This field is only valid for row-level type rules.This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is. + "attributes": { # Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field. + "a_key": "A String", + }, "column": "A String", # Optional. The unnested column which this rule is evaluated against. "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} @@ -2450,6 +2866,21 @@

Method Details

"rowConditionExpectation": { # Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 # Row-level rule which evaluates whether each row in a table passes the specified condition. "sqlExpression": "A String", # Optional. The SQL expression. }, + "ruleSource": { # Represents the rule source information from Catalog. # Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable. + "rulePathElements": [ # Output only. Rule path elements represent information about the individual items in the relationship path between the scan resource and rule origin in that order. + { # Path Element represents the direct relationship between the rule origin (aspects) to the BigQuery Entry. Ordering of the rule relationship will be maintained such that the first entry in the list is the closest ancestor (BigQuery table itself). A blank source denotes that the rule is derived directly from the DataScan itself. + "entryLinkSource": { # Entry link source represents information about the entry link. # Output only. Entry link source represents information about the entry link. + "entryLink": "A String", # Output only. The entry link name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "entryLinkType": "A String", # Output only. The entry link type to represent the current relationship between the entry and the next entry in the path. In the form of: projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id} + }, + "entrySource": { # Entry source represents information about the related source entry. # Output only. Entry source represents information about the related source entry. + "displayName": "A String", # Output only. The display name of the entry. + "entry": "A String", # Output only. The entry name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "entryType": "A String", # Output only. The entry type to represent the current characteristics of the entry in the form of: projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry-type-id}. + }, + }, + ], + }, "setExpectation": { # Evaluates whether each column value is contained by a specified set. # Row-level rule which evaluates whether each column value is contained by a specified set. "values": [ # Optional. Expected values for the column value. "A String", @@ -2469,6 +2900,33 @@

Method Details

"tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, + "templateReference": { # A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails # Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails. + "name": "A String", # Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "resolvedSql": "A String", # Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result. + "ruleTemplate": { # DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules. # Output only. The rule template used to resolve the rule. It is only populated in the result. + "capabilities": [ # Output only. A list of features or properties supported by this rule template. + "A String", + ], + "dimension": "A String", # Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level. + "inputParameters": { # Output only. Description for input parameters + "a_key": { # Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + "defaultValue": "A String", # Output only. The default value for the parameter if no value is provided. + "description": "A String", # Output only. Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + }, + }, + "name": "A String", # Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "sqlCollection": [ # Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported. + { # Templatized SQL query for data quality rules. It can have parameters that can be substituted with values when a rule is created using this template. + "query": "A String", # Output only. Templatized SQL query for data quality rules. + }, + ], + }, + "values": { # Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": { # Represents a parameter value. + "value": "A String", # Required. Represents the string value of the parameter. + }, + }, + }, "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for row-level type rules. "uniquenessExpectation": { # Evaluates whether the column has duplicates. # Row-level rule which evaluates whether each column value is unique. }, @@ -2486,6 +2944,8 @@

Method Details

}, "dataQualitySpec": { # DataQualityScan related setting. # Output only. Settings for a data quality scan. "catalogPublishingEnabled": True or False, # Optional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata. + "enableCatalogBasedRules": True or False, # Optional. If enabled, the data scan will retrieve rules defined in the dataplex-types.global.data-rules aspect on all paths of the catalog entry corresponding to the BigQuery table resource and all attached glossary terms. The path that data-rules aspect is attached on the table entry defines the column that the rule will be evaluated against. For glossary terms, the path that the terms are attached on the table entry defines the column that the rule will be evaluated against. At the start of scan execution, the rules reflect the latest state retrieved from the catalog entry and any updates on the rules thereafter are ignored for that execution. The updates will be reflected from the next execution. Rules defined in the datascan must be empty if this field is enabled. + "filter": "A String", # Optional. Filter for selectively running a subset of rules. You can filter the request by the name or attribute key-value pairs defined on the rule. If not specified, all rules are run. The filter is applicable to both, the rules retrieved from catalog and explicitly defined rules in the scan. Please see filter syntax (https://docs.cloud.google.com/dataplex/docs/auto-data-quality-overview#rule-filtering) for more details. "postScanActions": { # The configuration of post scan actions of DataQualityScan. # 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 DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -2508,6 +2968,9 @@

Method Details

"rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).Example: col1 >= 0 AND col2 < 10 "rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. { # A rule captures data quality intent about a data source. + "attributes": { # Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field. + "a_key": "A String", + }, "column": "A String", # Optional. The unnested column which this rule is evaluated against. "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} @@ -2533,6 +2996,21 @@

Method Details

"rowConditionExpectation": { # Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 # Row-level rule which evaluates whether each row in a table passes the specified condition. "sqlExpression": "A String", # Optional. The SQL expression. }, + "ruleSource": { # Represents the rule source information from Catalog. # Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable. + "rulePathElements": [ # Output only. Rule path elements represent information about the individual items in the relationship path between the scan resource and rule origin in that order. + { # Path Element represents the direct relationship between the rule origin (aspects) to the BigQuery Entry. Ordering of the rule relationship will be maintained such that the first entry in the list is the closest ancestor (BigQuery table itself). A blank source denotes that the rule is derived directly from the DataScan itself. + "entryLinkSource": { # Entry link source represents information about the entry link. # Output only. Entry link source represents information about the entry link. + "entryLink": "A String", # Output only. The entry link name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "entryLinkType": "A String", # Output only. The entry link type to represent the current relationship between the entry and the next entry in the path. In the form of: projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id} + }, + "entrySource": { # Entry source represents information about the related source entry. # Output only. Entry source represents information about the related source entry. + "displayName": "A String", # Output only. The display name of the entry. + "entry": "A String", # Output only. The entry name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "entryType": "A String", # Output only. The entry type to represent the current characteristics of the entry in the form of: projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry-type-id}. + }, + }, + ], + }, "setExpectation": { # Evaluates whether each column value is contained by a specified set. # Row-level rule which evaluates whether each column value is contained by a specified set. "values": [ # Optional. Expected values for the column value. "A String", @@ -2552,6 +3030,33 @@

Method Details

"tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, + "templateReference": { # A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails # Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails. + "name": "A String", # Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "resolvedSql": "A String", # Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result. + "ruleTemplate": { # DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules. # Output only. The rule template used to resolve the rule. It is only populated in the result. + "capabilities": [ # Output only. A list of features or properties supported by this rule template. + "A String", + ], + "dimension": "A String", # Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level. + "inputParameters": { # Output only. Description for input parameters + "a_key": { # Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + "defaultValue": "A String", # Output only. The default value for the parameter if no value is provided. + "description": "A String", # Output only. Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + }, + }, + "name": "A String", # Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "sqlCollection": [ # Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported. + { # Templatized SQL query for data quality rules. It can have parameters that can be substituted with values when a rule is created using this template. + "query": "A String", # Output only. Templatized SQL query for data quality rules. + }, + ], + }, + "values": { # Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": { # Represents a parameter value. + "value": "A String", # Required. Represents the string value of the parameter. + }, + }, + }, "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for row-level type rules. "uniquenessExpectation": { # Evaluates whether the column has duplicates. # Row-level rule which evaluates whether each column value is unique. }, diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html index bb56464f28..6bb99cc2b7 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html @@ -74,6 +74,9 @@

Cloud Dataplex API . projects . locations . dataScans . jobs

Instance Methods

+

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

+

Cancels a running/pending DataScan job.

close()

Close httplib2 connections.

@@ -90,6 +93,30 @@

Instance Methods

list_next()

Retrieves the next page of results.

Method Details

+
+ cancel(name, body=None, x__xgafv=None) +
Cancels a running/pending DataScan job.
+
+Args:
+  name: string, Required. The resource name of the DataScanJob: projects/{project_id_or_number}/locations/{location_id}/dataScans/{data_scan_id}/jobs/{data_scan_job_id} where project_id_or_number refers to a project_id or project_number and location_id refers to a Google Cloud region. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for the CancelDataScanJob method.
+}
+
+  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 the CancelDataScanJob method.
+}
+
+
close()
Close httplib2 connections.
@@ -118,6 +145,9 @@

Method Details

{ # Response details for data quality rule recommendations. "rule": [ # The data quality rules that Dataplex Universal Catalog generates based on the results of a data profiling scan. { # A rule captures data quality intent about a data source. + "attributes": { # Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field. + "a_key": "A String", + }, "column": "A String", # Optional. The unnested column which this rule is evaluated against. "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} @@ -143,6 +173,21 @@

Method Details

"rowConditionExpectation": { # Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 # Row-level rule which evaluates whether each row in a table passes the specified condition. "sqlExpression": "A String", # Optional. The SQL expression. }, + "ruleSource": { # Represents the rule source information from Catalog. # Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable. + "rulePathElements": [ # Output only. Rule path elements represent information about the individual items in the relationship path between the scan resource and rule origin in that order. + { # Path Element represents the direct relationship between the rule origin (aspects) to the BigQuery Entry. Ordering of the rule relationship will be maintained such that the first entry in the list is the closest ancestor (BigQuery table itself). A blank source denotes that the rule is derived directly from the DataScan itself. + "entryLinkSource": { # Entry link source represents information about the entry link. # Output only. Entry link source represents information about the entry link. + "entryLink": "A String", # Output only. The entry link name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "entryLinkType": "A String", # Output only. The entry link type to represent the current relationship between the entry and the next entry in the path. In the form of: projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id} + }, + "entrySource": { # Entry source represents information about the related source entry. # Output only. Entry source represents information about the related source entry. + "displayName": "A String", # Output only. The display name of the entry. + "entry": "A String", # Output only. The entry name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "entryType": "A String", # Output only. The entry type to represent the current characteristics of the entry in the form of: projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry-type-id}. + }, + }, + ], + }, "setExpectation": { # Evaluates whether each column value is contained by a specified set. # Row-level rule which evaluates whether each column value is contained by a specified set. "values": [ # Optional. Expected values for the column value. "A String", @@ -162,6 +207,33 @@

Method Details

"tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, + "templateReference": { # A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails # Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails. + "name": "A String", # Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "resolvedSql": "A String", # Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result. + "ruleTemplate": { # DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules. # Output only. The rule template used to resolve the rule. It is only populated in the result. + "capabilities": [ # Output only. A list of features or properties supported by this rule template. + "A String", + ], + "dimension": "A String", # Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level. + "inputParameters": { # Output only. Description for input parameters + "a_key": { # Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + "defaultValue": "A String", # Output only. The default value for the parameter if no value is provided. + "description": "A String", # Output only. Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + }, + }, + "name": "A String", # Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "sqlCollection": [ # Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported. + { # Templatized SQL query for data quality rules. It can have parameters that can be substituted with values when a rule is created using this template. + "query": "A String", # Output only. Templatized SQL query for data quality rules. + }, + ], + }, + "values": { # Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": { # Represents a parameter value. + "value": "A String", # Required. Represents the string value of the parameter. + }, + }, + }, "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for row-level type rules. "uniquenessExpectation": { # Evaluates whether the column has duplicates. # Row-level rule which evaluates whether each column value is unique. }, @@ -444,6 +516,9 @@

Method Details

"passed": True or False, # Output only. Whether the rule passed or failed. "passedCount": "A String", # Output only. The number of rows which passed a rule evaluation.This field is only valid for row-level type rules.This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is. + "attributes": { # Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field. + "a_key": "A String", + }, "column": "A String", # Optional. The unnested column which this rule is evaluated against. "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} @@ -469,6 +544,21 @@

Method Details

"rowConditionExpectation": { # Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 # Row-level rule which evaluates whether each row in a table passes the specified condition. "sqlExpression": "A String", # Optional. The SQL expression. }, + "ruleSource": { # Represents the rule source information from Catalog. # Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable. + "rulePathElements": [ # Output only. Rule path elements represent information about the individual items in the relationship path between the scan resource and rule origin in that order. + { # Path Element represents the direct relationship between the rule origin (aspects) to the BigQuery Entry. Ordering of the rule relationship will be maintained such that the first entry in the list is the closest ancestor (BigQuery table itself). A blank source denotes that the rule is derived directly from the DataScan itself. + "entryLinkSource": { # Entry link source represents information about the entry link. # Output only. Entry link source represents information about the entry link. + "entryLink": "A String", # Output only. The entry link name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "entryLinkType": "A String", # Output only. The entry link type to represent the current relationship between the entry and the next entry in the path. In the form of: projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id} + }, + "entrySource": { # Entry source represents information about the related source entry. # Output only. Entry source represents information about the related source entry. + "displayName": "A String", # Output only. The display name of the entry. + "entry": "A String", # Output only. The entry name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "entryType": "A String", # Output only. The entry type to represent the current characteristics of the entry in the form of: projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry-type-id}. + }, + }, + ], + }, "setExpectation": { # Evaluates whether each column value is contained by a specified set. # Row-level rule which evaluates whether each column value is contained by a specified set. "values": [ # Optional. Expected values for the column value. "A String", @@ -488,6 +578,33 @@

Method Details

"tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, + "templateReference": { # A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails # Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails. + "name": "A String", # Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "resolvedSql": "A String", # Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result. + "ruleTemplate": { # DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules. # Output only. The rule template used to resolve the rule. It is only populated in the result. + "capabilities": [ # Output only. A list of features or properties supported by this rule template. + "A String", + ], + "dimension": "A String", # Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level. + "inputParameters": { # Output only. Description for input parameters + "a_key": { # Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + "defaultValue": "A String", # Output only. The default value for the parameter if no value is provided. + "description": "A String", # Output only. Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + }, + }, + "name": "A String", # Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "sqlCollection": [ # Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported. + { # Templatized SQL query for data quality rules. It can have parameters that can be substituted with values when a rule is created using this template. + "query": "A String", # Output only. Templatized SQL query for data quality rules. + }, + ], + }, + "values": { # Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": { # Represents a parameter value. + "value": "A String", # Required. Represents the string value of the parameter. + }, + }, + }, "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for row-level type rules. "uniquenessExpectation": { # Evaluates whether the column has duplicates. # Row-level rule which evaluates whether each column value is unique. }, @@ -505,6 +622,8 @@

Method Details

}, "dataQualitySpec": { # DataQualityScan related setting. # Output only. Settings for a data quality scan. "catalogPublishingEnabled": True or False, # Optional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata. + "enableCatalogBasedRules": True or False, # Optional. If enabled, the data scan will retrieve rules defined in the dataplex-types.global.data-rules aspect on all paths of the catalog entry corresponding to the BigQuery table resource and all attached glossary terms. The path that data-rules aspect is attached on the table entry defines the column that the rule will be evaluated against. For glossary terms, the path that the terms are attached on the table entry defines the column that the rule will be evaluated against. At the start of scan execution, the rules reflect the latest state retrieved from the catalog entry and any updates on the rules thereafter are ignored for that execution. The updates will be reflected from the next execution. Rules defined in the datascan must be empty if this field is enabled. + "filter": "A String", # Optional. Filter for selectively running a subset of rules. You can filter the request by the name or attribute key-value pairs defined on the rule. If not specified, all rules are run. The filter is applicable to both, the rules retrieved from catalog and explicitly defined rules in the scan. Please see filter syntax (https://docs.cloud.google.com/dataplex/docs/auto-data-quality-overview#rule-filtering) for more details. "postScanActions": { # The configuration of post scan actions of DataQualityScan. # 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 DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -527,6 +646,9 @@

Method Details

"rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).Example: col1 >= 0 AND col2 < 10 "rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. { # A rule captures data quality intent about a data source. + "attributes": { # Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field. + "a_key": "A String", + }, "column": "A String", # Optional. The unnested column which this rule is evaluated against. "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} @@ -552,6 +674,21 @@

Method Details

"rowConditionExpectation": { # Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 # Row-level rule which evaluates whether each row in a table passes the specified condition. "sqlExpression": "A String", # Optional. The SQL expression. }, + "ruleSource": { # Represents the rule source information from Catalog. # Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable. + "rulePathElements": [ # Output only. Rule path elements represent information about the individual items in the relationship path between the scan resource and rule origin in that order. + { # Path Element represents the direct relationship between the rule origin (aspects) to the BigQuery Entry. Ordering of the rule relationship will be maintained such that the first entry in the list is the closest ancestor (BigQuery table itself). A blank source denotes that the rule is derived directly from the DataScan itself. + "entryLinkSource": { # Entry link source represents information about the entry link. # Output only. Entry link source represents information about the entry link. + "entryLink": "A String", # Output only. The entry link name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "entryLinkType": "A String", # Output only. The entry link type to represent the current relationship between the entry and the next entry in the path. In the form of: projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id} + }, + "entrySource": { # Entry source represents information about the related source entry. # Output only. Entry source represents information about the related source entry. + "displayName": "A String", # Output only. The display name of the entry. + "entry": "A String", # Output only. The entry name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "entryType": "A String", # Output only. The entry type to represent the current characteristics of the entry in the form of: projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry-type-id}. + }, + }, + ], + }, "setExpectation": { # Evaluates whether each column value is contained by a specified set. # Row-level rule which evaluates whether each column value is contained by a specified set. "values": [ # Optional. Expected values for the column value. "A String", @@ -571,6 +708,33 @@

Method Details

"tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, + "templateReference": { # A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails # Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails. + "name": "A String", # Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "resolvedSql": "A String", # Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result. + "ruleTemplate": { # DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules. # Output only. The rule template used to resolve the rule. It is only populated in the result. + "capabilities": [ # Output only. A list of features or properties supported by this rule template. + "A String", + ], + "dimension": "A String", # Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level. + "inputParameters": { # Output only. Description for input parameters + "a_key": { # Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + "defaultValue": "A String", # Output only. The default value for the parameter if no value is provided. + "description": "A String", # Output only. Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + }, + }, + "name": "A String", # Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "sqlCollection": [ # Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported. + { # Templatized SQL query for data quality rules. It can have parameters that can be substituted with values when a rule is created using this template. + "query": "A String", # Output only. Templatized SQL query for data quality rules. + }, + ], + }, + "values": { # Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": { # Represents a parameter value. + "value": "A String", # Required. Represents the string value of the parameter. + }, + }, + }, "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for row-level type rules. "uniquenessExpectation": { # Evaluates whether the column has duplicates. # Row-level rule which evaluates whether each column value is unique. }, @@ -863,6 +1027,9 @@

Method Details

"passed": True or False, # Output only. Whether the rule passed or failed. "passedCount": "A String", # Output only. The number of rows which passed a rule evaluation.This field is only valid for row-level type rules.This field is not set for rule SqlAssertion. "rule": { # A rule captures data quality intent about a data source. # Output only. The rule specified in the DataQualitySpec, as is. + "attributes": { # Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field. + "a_key": "A String", + }, "column": "A String", # Optional. The unnested column which this rule is evaluated against. "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} @@ -888,6 +1055,21 @@

Method Details

"rowConditionExpectation": { # Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 # Row-level rule which evaluates whether each row in a table passes the specified condition. "sqlExpression": "A String", # Optional. The SQL expression. }, + "ruleSource": { # Represents the rule source information from Catalog. # Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable. + "rulePathElements": [ # Output only. Rule path elements represent information about the individual items in the relationship path between the scan resource and rule origin in that order. + { # Path Element represents the direct relationship between the rule origin (aspects) to the BigQuery Entry. Ordering of the rule relationship will be maintained such that the first entry in the list is the closest ancestor (BigQuery table itself). A blank source denotes that the rule is derived directly from the DataScan itself. + "entryLinkSource": { # Entry link source represents information about the entry link. # Output only. Entry link source represents information about the entry link. + "entryLink": "A String", # Output only. The entry link name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "entryLinkType": "A String", # Output only. The entry link type to represent the current relationship between the entry and the next entry in the path. In the form of: projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id} + }, + "entrySource": { # Entry source represents information about the related source entry. # Output only. Entry source represents information about the related source entry. + "displayName": "A String", # Output only. The display name of the entry. + "entry": "A String", # Output only. The entry name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "entryType": "A String", # Output only. The entry type to represent the current characteristics of the entry in the form of: projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry-type-id}. + }, + }, + ], + }, "setExpectation": { # Evaluates whether each column value is contained by a specified set. # Row-level rule which evaluates whether each column value is contained by a specified set. "values": [ # Optional. Expected values for the column value. "A String", @@ -907,6 +1089,33 @@

Method Details

"tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, + "templateReference": { # A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails # Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails. + "name": "A String", # Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "resolvedSql": "A String", # Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result. + "ruleTemplate": { # DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules. # Output only. The rule template used to resolve the rule. It is only populated in the result. + "capabilities": [ # Output only. A list of features or properties supported by this rule template. + "A String", + ], + "dimension": "A String", # Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level. + "inputParameters": { # Output only. Description for input parameters + "a_key": { # Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + "defaultValue": "A String", # Output only. The default value for the parameter if no value is provided. + "description": "A String", # Output only. Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + }, + }, + "name": "A String", # Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "sqlCollection": [ # Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported. + { # Templatized SQL query for data quality rules. It can have parameters that can be substituted with values when a rule is created using this template. + "query": "A String", # Output only. Templatized SQL query for data quality rules. + }, + ], + }, + "values": { # Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": { # Represents a parameter value. + "value": "A String", # Required. Represents the string value of the parameter. + }, + }, + }, "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for row-level type rules. "uniquenessExpectation": { # Evaluates whether the column has duplicates. # Row-level rule which evaluates whether each column value is unique. }, @@ -924,6 +1133,8 @@

Method Details

}, "dataQualitySpec": { # DataQualityScan related setting. # Output only. Settings for a data quality scan. "catalogPublishingEnabled": True or False, # Optional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata. + "enableCatalogBasedRules": True or False, # Optional. If enabled, the data scan will retrieve rules defined in the dataplex-types.global.data-rules aspect on all paths of the catalog entry corresponding to the BigQuery table resource and all attached glossary terms. The path that data-rules aspect is attached on the table entry defines the column that the rule will be evaluated against. For glossary terms, the path that the terms are attached on the table entry defines the column that the rule will be evaluated against. At the start of scan execution, the rules reflect the latest state retrieved from the catalog entry and any updates on the rules thereafter are ignored for that execution. The updates will be reflected from the next execution. Rules defined in the datascan must be empty if this field is enabled. + "filter": "A String", # Optional. Filter for selectively running a subset of rules. You can filter the request by the name or attribute key-value pairs defined on the rule. If not specified, all rules are run. The filter is applicable to both, the rules retrieved from catalog and explicitly defined rules in the scan. Please see filter syntax (https://docs.cloud.google.com/dataplex/docs/auto-data-quality-overview#rule-filtering) for more details. "postScanActions": { # The configuration of post scan actions of DataQualityScan. # 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 DataQualityScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID @@ -946,6 +1157,9 @@

Method Details

"rowFilter": "A String", # Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).Example: col1 >= 0 AND col2 < 10 "rules": [ # Required. The list of rules to evaluate against a data source. At least one rule is required. { # A rule captures data quality intent about a data source. + "attributes": { # Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field. + "a_key": "A String", + }, "column": "A String", # Optional. The unnested column which this rule is evaluated against. "debugQueries": [ # Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. { # Specifies a SQL statement that is evaluated to return up to 10 scalar values that are used to debug rules. If the rule fails, the values can help diagnose the cause of the failure.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).You can also name results with an explicit alias using [AS] alias. For more information, see BigQuery explicit aliases (https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#explicit_alias_syntax).Example: SELECT MIN(col1) AS min_col1, MAX(col1) AS max_col1 FROM ${data()} @@ -971,6 +1185,21 @@

Method Details

"rowConditionExpectation": { # Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 # Row-level rule which evaluates whether each row in a table passes the specified condition. "sqlExpression": "A String", # Optional. The SQL expression. }, + "ruleSource": { # Represents the rule source information from Catalog. # Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable. + "rulePathElements": [ # Output only. Rule path elements represent information about the individual items in the relationship path between the scan resource and rule origin in that order. + { # Path Element represents the direct relationship between the rule origin (aspects) to the BigQuery Entry. Ordering of the rule relationship will be maintained such that the first entry in the list is the closest ancestor (BigQuery table itself). A blank source denotes that the rule is derived directly from the DataScan itself. + "entryLinkSource": { # Entry link source represents information about the entry link. # Output only. Entry link source represents information about the entry link. + "entryLink": "A String", # Output only. The entry link name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} + "entryLinkType": "A String", # Output only. The entry link type to represent the current relationship between the entry and the next entry in the path. In the form of: projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id} + }, + "entrySource": { # Entry source represents information about the related source entry. # Output only. Entry source represents information about the related source entry. + "displayName": "A String", # Output only. The display name of the entry. + "entry": "A String", # Output only. The entry name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "entryType": "A String", # Output only. The entry type to represent the current characteristics of the entry in the form of: projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry-type-id}. + }, + }, + ], + }, "setExpectation": { # Evaluates whether each column value is contained by a specified set. # Row-level rule which evaluates whether each column value is contained by a specified set. "values": [ # Optional. Expected values for the column value. "A String", @@ -990,6 +1219,33 @@

Method Details

"tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, + "templateReference": { # A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails # Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails. + "name": "A String", # Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "resolvedSql": "A String", # Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result. + "ruleTemplate": { # DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules. # Output only. The rule template used to resolve the rule. It is only populated in the result. + "capabilities": [ # Output only. A list of features or properties supported by this rule template. + "A String", + ], + "dimension": "A String", # Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level. + "inputParameters": { # Output only. Description for input parameters + "a_key": { # Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + "defaultValue": "A String", # Output only. The default value for the parameter if no value is provided. + "description": "A String", # Output only. Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template. + }, + }, + "name": "A String", # Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} + "sqlCollection": [ # Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported. + { # Templatized SQL query for data quality rules. It can have parameters that can be substituted with values when a rule is created using this template. + "query": "A String", # Output only. Templatized SQL query for data quality rules. + }, + ], + }, + "values": { # Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8). + "a_key": { # Represents a parameter value. + "value": "A String", # Required. Represents the string value of the parameter. + }, + }, + }, "threshold": 3.14, # Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for row-level type rules. "uniquenessExpectation": { # Evaluates whether the column has duplicates. # Row-level rule which evaluates whether each column value is unique. }, diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json index f70c167ec4..5cc2f3a374 100644 --- a/googleapiclient/discovery_cache/documents/dataplex.v1.json +++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json @@ -2685,6 +2685,35 @@ "resources": { "jobs": { "methods": { +"cancel": { +"description": "Cancels a running/pending DataScan job.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs/{jobsId}:cancel", +"httpMethod": "POST", +"id": "dataplex.projects.locations.dataScans.jobs.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the DataScanJob: projects/{project_id_or_number}/locations/{location_id}/dataScans/{data_scan_id}/jobs/{data_scan_job_id} where project_id_or_number refers to a project_id or project_number and location_id refers to a Google Cloud region.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+/jobs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"request": { +"$ref": "GoogleCloudDataplexV1CancelDataScanJobRequest" +}, +"response": { +"$ref": "GoogleCloudDataplexV1CancelDataScanJobResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" +] +}, "generateDataQualityRules": { "description": "Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataScans/{dataScansId}/jobs/{jobsId}:generateDataQualityRules", @@ -7555,7 +7584,7 @@ } } }, -"revision": "20260402", +"revision": "20260406", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -8461,6 +8490,18 @@ }, "type": "object" }, +"GoogleCloudDataplexV1CancelDataScanJobRequest": { +"description": "Request message for the CancelDataScanJob method.", +"id": "GoogleCloudDataplexV1CancelDataScanJobRequest", +"properties": {}, +"type": "object" +}, +"GoogleCloudDataplexV1CancelDataScanJobResponse": { +"description": "Response message for the CancelDataScanJob method.", +"id": "GoogleCloudDataplexV1CancelDataScanJobResponse", +"properties": {}, +"type": "object" +}, "GoogleCloudDataplexV1CancelJobRequest": { "description": "Cancel task jobs.", "id": "GoogleCloudDataplexV1CancelJobRequest", @@ -9839,6 +9880,13 @@ "description": "A rule captures data quality intent about a data source.", "id": "GoogleCloudDataplexV1DataQualityRule", "properties": { +"attributes": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field.", +"type": "object" +}, "column": { "description": "Optional. The unnested column which this rule is evaluated against.", "type": "string" @@ -9882,6 +9930,11 @@ "$ref": "GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation", "description": "Row-level rule which evaluates whether each row in a table passes the specified condition." }, +"ruleSource": { +"$ref": "GoogleCloudDataplexV1DataQualityRuleRuleSource", +"description": "Output only. Contains information about the source of the rule and its relationship with the BigQuery table, where applicable.", +"readOnly": true +}, "setExpectation": { "$ref": "GoogleCloudDataplexV1DataQualityRuleSetExpectation", "description": "Row-level rule which evaluates whether each column value is contained by a specified set." @@ -9902,6 +9955,10 @@ "$ref": "GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation", "description": "Aggregate rule which evaluates whether the provided expression is true for a table." }, +"templateReference": { +"$ref": "GoogleCloudDataplexV1DataQualityRuleTemplateReference", +"description": "Aggregate rule which references a rule template and provides the parameters to be substituted in the template. If any rows are returned, this rule fails." +}, "threshold": { "description": "Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for row-level type rules.", "format": "double", @@ -10074,6 +10131,77 @@ }, "type": "object" }, +"GoogleCloudDataplexV1DataQualityRuleRuleSource": { +"description": "Represents the rule source information from Catalog.", +"id": "GoogleCloudDataplexV1DataQualityRuleRuleSource", +"properties": { +"rulePathElements": { +"description": "Output only. Rule path elements represent information about the individual items in the relationship path between the scan resource and rule origin in that order.", +"items": { +"$ref": "GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElement" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElement": { +"description": "Path Element represents the direct relationship between the rule origin (aspects) to the BigQuery Entry. Ordering of the rule relationship will be maintained such that the first entry in the list is the closest ancestor (BigQuery table itself). A blank source denotes that the rule is derived directly from the DataScan itself.", +"id": "GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElement", +"properties": { +"entryLinkSource": { +"$ref": "GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElementEntryLinkSource", +"description": "Output only. Entry link source represents information about the entry link.", +"readOnly": true +}, +"entrySource": { +"$ref": "GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElementEntrySource", +"description": "Output only. Entry source represents information about the related source entry.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElementEntryLinkSource": { +"description": "Entry link source represents information about the entry link.", +"id": "GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElementEntryLinkSource", +"properties": { +"entryLink": { +"description": "Output only. The entry link name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}", +"readOnly": true, +"type": "string" +}, +"entryLinkType": { +"description": "Output only. The entry link type to represent the current relationship between the entry and the next entry in the path. In the form of: projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id}", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElementEntrySource": { +"description": "Entry source represents information about the related source entry.", +"id": "GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElementEntrySource", +"properties": { +"displayName": { +"description": "Output only. The display name of the entry.", +"readOnly": true, +"type": "string" +}, +"entry": { +"description": "Output only. The entry name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}", +"readOnly": true, +"type": "string" +}, +"entryType": { +"description": "Output only. The entry type to represent the current characteristics of the entry in the form of: projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry-type-id}.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDataplexV1DataQualityRuleSetExpectation": { "description": "Evaluates whether each column value is contained by a specified set.", "id": "GoogleCloudDataplexV1DataQualityRuleSetExpectation", @@ -10149,6 +10277,115 @@ }, "type": "object" }, +"GoogleCloudDataplexV1DataQualityRuleTemplate": { +"description": "DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules.", +"id": "GoogleCloudDataplexV1DataQualityRuleTemplate", +"properties": { +"capabilities": { +"description": "Output only. A list of features or properties supported by this rule template.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"dimension": { +"description": "Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level.", +"readOnly": true, +"type": "string" +}, +"inputParameters": { +"additionalProperties": { +"$ref": "GoogleCloudDataplexV1DataQualityRuleTemplateParameterDescription" +}, +"description": "Output only. Description for input parameters", +"readOnly": true, +"type": "object" +}, +"name": { +"description": "Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}", +"readOnly": true, +"type": "string" +}, +"sqlCollection": { +"description": "Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported.", +"items": { +"$ref": "GoogleCloudDataplexV1DataQualityRuleTemplateSql" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1DataQualityRuleTemplateParameterDescription": { +"description": "Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template.", +"id": "GoogleCloudDataplexV1DataQualityRuleTemplateParameterDescription", +"properties": { +"defaultValue": { +"description": "Output only. The default value for the parameter if no value is provided.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Output only. Description of the input parameter. It can include the type(s) supported by the parameter and intended usage. It is for information purposes only and does not affect the behavior of the rule template.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1DataQualityRuleTemplateReference": { +"description": "A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails", +"id": "GoogleCloudDataplexV1DataQualityRuleTemplateReference", +"properties": { +"name": { +"description": "Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}", +"type": "string" +}, +"resolvedSql": { +"description": "Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result.", +"readOnly": true, +"type": "string" +}, +"ruleTemplate": { +"$ref": "GoogleCloudDataplexV1DataQualityRuleTemplate", +"description": "Output only. The rule template used to resolve the rule. It is only populated in the result.", +"readOnly": true +}, +"values": { +"additionalProperties": { +"$ref": "GoogleCloudDataplexV1DataQualityRuleTemplateReferenceParameterValue" +}, +"description": "Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8).", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1DataQualityRuleTemplateReferenceParameterValue": { +"description": "Represents a parameter value.", +"id": "GoogleCloudDataplexV1DataQualityRuleTemplateReferenceParameterValue", +"properties": { +"value": { +"description": "Required. Represents the string value of the parameter.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1DataQualityRuleTemplateSql": { +"description": "Templatized SQL query for data quality rules. It can have parameters that can be substituted with values when a rule is created using this template.", +"id": "GoogleCloudDataplexV1DataQualityRuleTemplateSql", +"properties": { +"query": { +"description": "Output only. Templatized SQL query for data quality rules.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDataplexV1DataQualityRuleUniquenessExpectation": { "description": "Evaluates whether the column has duplicates.", "id": "GoogleCloudDataplexV1DataQualityRuleUniquenessExpectation", @@ -10239,7 +10476,8 @@ "STATISTIC_RANGE_EXPECTATION", "TABLE_CONDITION_EXPECTATION", "UNIQUENESS_EXPECTATION", -"SQL_ASSERTION" +"SQL_ASSERTION", +"TEMPLATE_REFERENCE" ], "enumDescriptions": [ "An unspecified rule type.", @@ -10251,7 +10489,8 @@ "See DataQualityRule.StatisticRangeExpectation.", "See DataQualityRule.TableConditionExpectation.", "See DataQualityRule.UniquenessExpectation.", -"See DataQualityRule.SqlAssertion." +"See DataQualityRule.SqlAssertion.", +"See DataQualityRule.TemplateReference." ], "type": "string" }, @@ -10271,6 +10510,14 @@ "description": "Optional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata.", "type": "boolean" }, +"enableCatalogBasedRules": { +"description": "Optional. If enabled, the data scan will retrieve rules defined in the dataplex-types.global.data-rules aspect on all paths of the catalog entry corresponding to the BigQuery table resource and all attached glossary terms. The path that data-rules aspect is attached on the table entry defines the column that the rule will be evaluated against. For glossary terms, the path that the terms are attached on the table entry defines the column that the rule will be evaluated against. At the start of scan execution, the rules reflect the latest state retrieved from the catalog entry and any updates on the rules thereafter are ignored for that execution. The updates will be reflected from the next execution. Rules defined in the datascan must be empty if this field is enabled.", +"type": "boolean" +}, +"filter": { +"description": "Optional. Filter for selectively running a subset of rules. You can filter the request by the name or attribute key-value pairs defined on the rule. If not specified, all rules are run. The filter is applicable to both, the rules retrieved from catalog and explicitly defined rules in the scan. Please see filter syntax (https://docs.cloud.google.com/dataplex/docs/auto-data-quality-overview#rule-filtering) for more details.", +"type": "string" +}, "postScanActions": { "$ref": "GoogleCloudDataplexV1DataQualitySpecPostScanActions", "description": "Optional. Actions to take upon job completion." From cf122c084ade212438b426c0897297d625defaf3 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:40:59 +0000 Subject: [PATCH 12/32] feat(dataproc): update the api #### dataproc:v1 The following keys were added: - schemas.Batch.properties.pysparkNotebookBatch.$ref (Total Keys: 1) - schemas.PySparkNotebookBatch (Total Keys: 13) --- ...ataproc_v1.projects.locations.batches.html | 54 +++++++++++++++++++ .../documents/dataproc.v1.json | 52 +++++++++++++++++- 2 files changed, 105 insertions(+), 1 deletion(-) diff --git a/docs/dyn/dataproc_v1.projects.locations.batches.html b/docs/dyn/dataproc_v1.projects.locations.batches.html index 3694b69793..563fc08244 100644 --- a/docs/dyn/dataproc_v1.projects.locations.batches.html +++ b/docs/dyn/dataproc_v1.projects.locations.batches.html @@ -207,6 +207,24 @@

Method Details

"A String", ], }, + "pysparkNotebookBatch": { # A configuration for running a PySpark Notebook batch workload. # Optional. PySpark notebook batch config. + "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. + "A String", + ], + "fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor + "A String", + ], + "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH. + "A String", + ], + "notebookFileUri": "A String", # Required. The HCFS URI of the notebook file to execute. + "params": { # Optional. The parameters to pass to the notebook. + "a_key": "A String", + }, + "pythonFileUris": [ # Optional. HCFS URIs of Python files to pass to the PySpark framework. + "A String", + ], + }, "runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for the batch execution. "autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload. "scenarios": [ # Optional. Scenarios for which tunings are applied. @@ -423,6 +441,24 @@

Method Details

"A String", ], }, + "pysparkNotebookBatch": { # A configuration for running a PySpark Notebook batch workload. # Optional. PySpark notebook batch config. + "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. + "A String", + ], + "fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor + "A String", + ], + "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH. + "A String", + ], + "notebookFileUri": "A String", # Required. The HCFS URI of the notebook file to execute. + "params": { # Optional. The parameters to pass to the notebook. + "a_key": "A String", + }, + "pythonFileUris": [ # Optional. HCFS URIs of Python files to pass to the PySpark framework. + "A String", + ], + }, "runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for the batch execution. "autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload. "scenarios": [ # Optional. Scenarios for which tunings are applied. @@ -597,6 +633,24 @@

Method Details

"A String", ], }, + "pysparkNotebookBatch": { # A configuration for running a PySpark Notebook batch workload. # Optional. PySpark notebook batch config. + "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. + "A String", + ], + "fileUris": [ # Optional. HCFS URIs of files to be placed in the working directory of each executor + "A String", + ], + "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH. + "A String", + ], + "notebookFileUri": "A String", # Required. The HCFS URI of the notebook file to execute. + "params": { # Optional. The parameters to pass to the notebook. + "a_key": "A String", + }, + "pythonFileUris": [ # Optional. HCFS URIs of Python files to pass to the PySpark framework. + "A String", + ], + }, "runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for the batch execution. "autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload. "scenarios": [ # Optional. Scenarios for which tunings are applied. diff --git a/googleapiclient/discovery_cache/documents/dataproc.v1.json b/googleapiclient/discovery_cache/documents/dataproc.v1.json index 1be8631bf8..b819ebd0eb 100644 --- a/googleapiclient/discovery_cache/documents/dataproc.v1.json +++ b/googleapiclient/discovery_cache/documents/dataproc.v1.json @@ -5224,7 +5224,7 @@ } } }, -"revision": "20260327", +"revision": "20260407", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -5927,6 +5927,10 @@ "$ref": "PySparkBatch", "description": "Optional. PySpark batch config." }, +"pysparkNotebookBatch": { +"$ref": "PySparkNotebookBatch", +"description": "Optional. PySpark notebook batch config." +}, "runtimeConfig": { "$ref": "RuntimeConfig", "description": "Optional. Runtime configuration for the batch execution." @@ -9651,6 +9655,52 @@ }, "type": "object" }, +"PySparkNotebookBatch": { +"description": "A configuration for running a PySpark Notebook batch workload.", +"id": "PySparkNotebookBatch", +"properties": { +"archiveUris": { +"description": "Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.", +"items": { +"type": "string" +}, +"type": "array" +}, +"fileUris": { +"description": "Optional. HCFS URIs of files to be placed in the working directory of each executor", +"items": { +"type": "string" +}, +"type": "array" +}, +"jarFileUris": { +"description": "Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.", +"items": { +"type": "string" +}, +"type": "array" +}, +"notebookFileUri": { +"description": "Required. The HCFS URI of the notebook file to execute.", +"type": "string" +}, +"params": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The parameters to pass to the notebook.", +"type": "object" +}, +"pythonFileUris": { +"description": "Optional. HCFS URIs of Python files to pass to the PySpark framework.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "Quantiles": { "description": "Quantile metrics data related to Tasks. Units can be seconds, bytes, milliseconds, etc depending on the message type.", "id": "Quantiles", From f750ec96e92608af3596266855e2496663412ec2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:40:59 +0000 Subject: [PATCH 13/32] feat(developerconnect): update the api #### developerconnect:v1 The following keys were added: - schemas.AccountConnector.properties.uid (Total Keys: 2) - schemas.ProxyConfig.properties.httpProxyBaseUri (Total Keys: 2) --- ...nect_v1.projects.locations.accountConnectors.html | 8 ++++++++ .../documents/developerconnect.v1.json | 12 +++++++++++- 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/dyn/developerconnect_v1.projects.locations.accountConnectors.html b/docs/dyn/developerconnect_v1.projects.locations.accountConnectors.html index 8baf031a07..91579a2489 100644 --- a/docs/dyn/developerconnect_v1.projects.locations.accountConnectors.html +++ b/docs/dyn/developerconnect_v1.projects.locations.accountConnectors.html @@ -157,7 +157,9 @@

Method Details

}, "proxyConfig": { # The proxy configuration. # Optional. Configuration for the http and git proxy features. "enabled": True or False, # Optional. Setting this to true allows the git and http proxies to perform actions on behalf of the user configured under the account connector. + "httpProxyBaseUri": "A String", # Output only. The base URI for the HTTP proxy endpoint. Has the format `https://{generatedID}-a-h-{shortRegion}.developerconnect.dev` Populated only when `enabled` is set to `true`. This endpoint is used by other Google services that integrate with Developer Connect. }, + "uid": "A String", # Output only. A system-assigned unique identifier for the Account Connector. "updateTime": "A String", # Output only. The timestamp when the accountConnector was updated. } @@ -325,7 +327,9 @@

Method Details

}, "proxyConfig": { # The proxy configuration. # Optional. Configuration for the http and git proxy features. "enabled": True or False, # Optional. Setting this to true allows the git and http proxies to perform actions on behalf of the user configured under the account connector. + "httpProxyBaseUri": "A String", # Output only. The base URI for the HTTP proxy endpoint. Has the format `https://{generatedID}-a-h-{shortRegion}.developerconnect.dev` Populated only when `enabled` is set to `true`. This endpoint is used by other Google services that integrate with Developer Connect. }, + "uid": "A String", # Output only. A system-assigned unique identifier for the Account Connector. "updateTime": "A String", # Output only. The timestamp when the accountConnector was updated. }
@@ -386,7 +390,9 @@

Method Details

}, "proxyConfig": { # The proxy configuration. # Optional. Configuration for the http and git proxy features. "enabled": True or False, # Optional. Setting this to true allows the git and http proxies to perform actions on behalf of the user configured under the account connector. + "httpProxyBaseUri": "A String", # Output only. The base URI for the HTTP proxy endpoint. Has the format `https://{generatedID}-a-h-{shortRegion}.developerconnect.dev` Populated only when `enabled` is set to `true`. This endpoint is used by other Google services that integrate with Developer Connect. }, + "uid": "A String", # Output only. A system-assigned unique identifier for the Account Connector. "updateTime": "A String", # Output only. The timestamp when the accountConnector was updated. }, ], @@ -456,7 +462,9 @@

Method Details

}, "proxyConfig": { # The proxy configuration. # Optional. Configuration for the http and git proxy features. "enabled": True or False, # Optional. Setting this to true allows the git and http proxies to perform actions on behalf of the user configured under the account connector. + "httpProxyBaseUri": "A String", # Output only. The base URI for the HTTP proxy endpoint. Has the format `https://{generatedID}-a-h-{shortRegion}.developerconnect.dev` Populated only when `enabled` is set to `true`. This endpoint is used by other Google services that integrate with Developer Connect. }, + "uid": "A String", # Output only. A system-assigned unique identifier for the Account Connector. "updateTime": "A String", # Output only. The timestamp when the accountConnector was updated. } diff --git a/googleapiclient/discovery_cache/documents/developerconnect.v1.json b/googleapiclient/discovery_cache/documents/developerconnect.v1.json index b4e7eace69..070e283352 100644 --- a/googleapiclient/discovery_cache/documents/developerconnect.v1.json +++ b/googleapiclient/discovery_cache/documents/developerconnect.v1.json @@ -1795,7 +1795,7 @@ } } }, -"revision": "20260319", +"revision": "20260403", "rootUrl": "https://developerconnect.googleapis.com/", "schemas": { "AccountConnector": { @@ -1847,6 +1847,11 @@ "$ref": "ProxyConfig", "description": "Optional. Configuration for the http and git proxy features." }, +"uid": { +"description": "Output only. A system-assigned unique identifier for the Account Connector.", +"readOnly": true, +"type": "string" +}, "updateTime": { "description": "Output only. The timestamp when the accountConnector was updated.", "format": "google-datetime", @@ -3425,6 +3430,11 @@ "enabled": { "description": "Optional. Setting this to true allows the git and http proxies to perform actions on behalf of the user configured under the account connector.", "type": "boolean" +}, +"httpProxyBaseUri": { +"description": "Output only. The base URI for the HTTP proxy endpoint. Has the format `https://{generatedID}-a-h-{shortRegion}.developerconnect.dev` Populated only when `enabled` is set to `true`. This endpoint is used by other Google services that integrate with Developer Connect.", +"readOnly": true, +"type": "string" } }, "type": "object" From 0535a62913ea1bfcbbd4078880e1bfb665caeaf8 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:41:00 +0000 Subject: [PATCH 14/32] feat(discoveryengine): update the api #### discoveryengine:v1 The following keys were added: - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.distributeLicenseConfig (Total Keys: 12) - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.retractLicenseConfig (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.dataConnector.methods.mcp (Total Keys: 25) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.create.parameters.sessionId (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.create.parameters.sessionId (Total Keys: 2) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.create.parameters.sessionId (Total Keys: 2) - resources.projects.resources.locations.resources.userStores.resources.userLicenses.methods.list.parameters.filter (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1ActionConfig.properties.createBapConnection.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1AssistAnswerReply.properties.createTime (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1Assistant.properties.createTime (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1Assistant.properties.updateTime (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1CliConfig (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1DataConnector.properties.cliConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DistributeLicenseConfigRequest (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1DistributeLicenseConfigResponse (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1RetractLicenseConfigRequest (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1RetractLicenseConfigResponse (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1SearchRequest.properties.customRankingParams.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1SearchRequest.properties.entity.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1SearchRequestCustomRankingParams (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals.properties.precomputedExpressionValues (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1UserInfo.properties.preciseLocation.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1UserInfoPreciseLocation (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1alphaActionConfig.properties.createBapConnection.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaAnswer.properties.blobAttachments.readOnly (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaAssistAnswerReply.properties.createTime (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaCliConfig (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.cliConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.dataProtectionPolicy.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.customRankingParams.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.entity.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1alphaUserInfo.properties.preciseLocation.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.customRankingParams.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.entity.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1betaUserInfo.properties.preciseLocation.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation (Total Keys: 4) - schemas.GoogleTypeLatLng (Total Keys: 6) The following keys were changed: - resources.projects.methods.provision.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.getAclConfig.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.getCmekConfig.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.setUpDataConnector.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.setUpDataConnectorV2.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.updateAclConfig.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.updateCmekConfig.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.cmekConfigs.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.cmekConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.cmekConfigs.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.cmekConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.methods.getDataConnector.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.methods.updateDataConnector.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataConnector.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataConnector.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.completeQuery.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.getSiteSearchEngine.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.trainCustomModel.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.methods.batchGetDocumentsMetadata.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.operations.methods.cancel.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.completionConfig.methods.completeQuery.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.completionSuggestions.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.completionSuggestions.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.controls.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.controls.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.controls.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.controls.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.controls.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.conversations.methods.converse.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.conversations.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.conversations.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.conversations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.conversations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.conversations.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.customModels.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.models.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.models.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.answer.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.recommend.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.search.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.searchLite.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.streamAnswer.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.resources.answers.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.batchVerifyTargetSites.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.disableAdvancedSiteSearch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.enableAdvancedSiteSearch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.fetchDomainVerificationStatus.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.batchCreate.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.suggestionDenyListEntries.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.suggestionDenyListEntries.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.userEvents.methods.collect.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.userEvents.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.userEvents.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.userEvents.methods.write.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.getIamPolicy.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.setIamPolicy.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.methods.streamAssist.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.a2a.resources.v1.methods.getCard.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.a2a.resources.v1.resources.message.methods.send.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.a2a.resources.v1.resources.message.methods.stream.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.a2a.resources.v1.resources.tasks.methods.cancel.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.a2a.resources.v1.resources.tasks.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.a2a.resources.v1.resources.tasks.methods.subscribe.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.a2a.resources.v1.resources.tasks.resources.pushNotificationConfigs.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.a2a.resources.v1.resources.tasks.resources.pushNotificationConfigs.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.a2a.resources.v1.resources.tasks.resources.pushNotificationConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.a2a.resources.v1.resources.tasks.resources.pushNotificationConfigs.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.completeQuery.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.controls.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.controls.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.controls.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.controls.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.controls.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.conversations.methods.converse.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.conversations.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.conversations.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.conversations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.conversations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.conversations.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.operations.methods.cancel.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.answer.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.searchLite.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.streamAnswer.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.resources.answers.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.completeQuery.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.getSiteSearchEngine.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.methods.batchGetDocumentsMetadata.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.operations.methods.cancel.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.completionConfig.methods.completeQuery.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.completionSuggestions.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.completionSuggestions.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.controls.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.controls.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.controls.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.controls.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.controls.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.conversations.methods.converse.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.conversations.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.conversations.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.conversations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.conversations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.conversations.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.models.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.models.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.schemas.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.schemas.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.schemas.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.schemas.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.schemas.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.answer.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.recommend.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.search.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.searchLite.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.streamAnswer.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.sessions.resources.answers.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.disableAdvancedSiteSearch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.enableAdvancedSiteSearch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.batchCreate.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.suggestionDenyListEntries.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.suggestionDenyListEntries.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.userEvents.methods.collect.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.userEvents.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.userEvents.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.userEvents.methods.write.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.groundingConfigs.methods.check.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.licenseConfigs.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.licenseConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.licenseConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.podcasts.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rankingConfigs.methods.rank.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userEvents.methods.collect.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userEvents.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userEvents.methods.write.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userStores.methods.batchUpdateUserLicenses.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userStores.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userStores.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userStores.resources.licenseConfigsUsageStats.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userStores.resources.userLicenses.methods.list.scopes (Total Keys: 1) - resources.projects.resources.operations.methods.cancel.scopes (Total Keys: 1) - resources.projects.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.operations.methods.list.scopes (Total Keys: 1) #### discoveryengine:v1alpha The following keys were added: - resources.projects.resources.locations.resources.collections.resources.dataConnector.methods.mcp (Total Keys: 25) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.create.parameters.sessionId (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.create.parameters.sessionId (Total Keys: 2) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.create.parameters.sessionId (Total Keys: 2) - resources.projects.resources.locations.resources.userStores.resources.userLicenses.methods.list.parameters.filter (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1ActionConfig.properties.createBapConnection.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1Assistant.properties.createTime (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1Assistant.properties.updateTime (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1CliConfig (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1DataConnector.properties.cliConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaActionConfig.properties.createBapConnection.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaAnswer.properties.blobAttachments.readOnly (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaAssistAnswerReply.properties.createTime (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaAssistant.properties.createTime (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1alphaAssistant.properties.updateTime (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1alphaCliConfig (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.cliConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.dataProtectionPolicy.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.customRankingParams.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.entity.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResultRankSignals.properties.precomputedExpressionValues (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1alphaUserInfo.properties.preciseLocation.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.customRankingParams.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.entity.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1betaUserInfo.properties.preciseLocation.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation (Total Keys: 4) - schemas.GoogleTypeLatLng (Total Keys: 6) The following keys were changed: - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.distributeLicenseConfig.scopes (Total Keys: 1) - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.get.scopes (Total Keys: 1) - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list.scopes (Total Keys: 1) - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.retractLicenseConfig.scopes (Total Keys: 1) - resources.projects.methods.get.scopes (Total Keys: 1) - resources.projects.methods.patch.scopes (Total Keys: 1) - resources.projects.methods.provision.scopes (Total Keys: 1) - resources.projects.methods.reportConsentChange.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.completeExternalIdentities.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.estimateDataSize.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.getAclConfig.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.getCmekConfig.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.obtainCrawlRate.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.queryConfigurablePricingUsageStats.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.removeDedicatedCrawlRate.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.setDedicatedCrawlRate.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.setUpDataConnector.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.setUpDataConnectorV2.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.updateAclConfig.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.updateCmekConfig.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.authorizations.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.authorizations.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.authorizations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.authorizations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.authorizations.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.cmekConfigs.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.cmekConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.cmekConfigs.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.cmekConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.methods.getDataConnector.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.methods.updateDataConnector.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataConnector.methods.acquireAccessToken.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataConnector.methods.checkRefreshToken.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataConnector.methods.getConnectorSecret.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataConnector.methods.startConnectorRun.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataConnector.resources.connectorRuns.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataConnector.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataConnector.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.addPatientFilter.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.completeQuery.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.deletePatientFilter.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.getDocumentProcessingConfig.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.getSiteSearchEngine.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.removePatientFilter.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.replacePatientFilter.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.trainCustomModel.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.updateDocumentProcessingConfig.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.methods.batchGetDocumentsMetadata.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.getProcessedDocument.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.operations.methods.cancel.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.completionConfig.methods.completeQuery.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.completionSuggestions.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.completionSuggestions.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.controls.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.controls.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.controls.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.controls.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.controls.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.conversations.methods.converse.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.conversations.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.conversations.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.conversations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.conversations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.conversations.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.customModels.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.models.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.models.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.answer.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.recommend.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.search.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.searchLite.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.streamAnswer.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.resources.answers.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.batchVerifyTargetSites.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.disableAdvancedSiteSearch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.enableAdvancedSiteSearch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.fetchDomainVerificationStatus.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.getUriPatternDocumentData.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.setUriPatternDocumentData.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.batchCreate.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.suggestionDenyListEntries.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.suggestionDenyListEntries.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.userEvents.methods.collect.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.userEvents.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.userEvents.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.userEvents.methods.write.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.getIamPolicy.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.getWorkspaceSettings.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.pause.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.resume.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.setIamPolicy.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.tune.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.analytics.methods.exportMetrics.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.analytics.methods.getConfig.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.analytics.methods.updateConfig.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.methods.streamAssist.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.files.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.cannedQueries.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.cannedQueries.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.cannedQueries.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.cannedQueries.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.cannedQueries.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.completeQuery.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.controls.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.controls.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.controls.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.controls.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.controls.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.conversations.methods.converse.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.conversations.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.conversations.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.conversations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.conversations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.conversations.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.answer.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.searchLite.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.streamAnswer.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.resources.alphaEvolveExperiments.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.resources.answers.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.resources.files.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.addPatientFilter.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.completeQuery.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.deletePatientFilter.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.getDocumentProcessingConfig.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.getSiteSearchEngine.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.removePatientFilter.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.replacePatientFilter.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.updateDocumentProcessingConfig.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.methods.batchGetDocumentsMetadata.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.getProcessedDocument.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.resources.chunks.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.operations.methods.cancel.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.completionConfig.methods.completeQuery.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.completionSuggestions.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.completionSuggestions.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.controls.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.controls.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.controls.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.controls.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.controls.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.conversations.methods.converse.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.conversations.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.conversations.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.conversations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.conversations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.conversations.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.models.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.models.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.schemas.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.schemas.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.schemas.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.schemas.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.schemas.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.answer.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.recommend.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.search.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.searchLite.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.streamAnswer.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.sessions.resources.answers.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.disableAdvancedSiteSearch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.enableAdvancedSiteSearch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.batchCreate.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.suggestionDenyListEntries.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.suggestionDenyListEntries.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.userEvents.methods.collect.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.userEvents.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.userEvents.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.userEvents.methods.write.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.evaluations.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.evaluations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.evaluations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.evaluations.methods.listResults.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.evaluations.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.groundingConfigs.methods.check.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.licenseConfigs.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.licenseConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.licenseConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.notebooks.methods.batchDelete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.notebooks.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.notebooks.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.notebooks.methods.listRecentlyViewed.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.notebooks.methods.share.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.notebooks.resources.audioOverviews.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.notebooks.resources.audioOverviews.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.notebooks.resources.sources.methods.batchCreate.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.notebooks.resources.sources.methods.batchDelete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.notebooks.resources.sources.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.podcasts.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rankingConfigs.methods.rank.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.requirements.methods.checkRequirement.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userEvents.methods.collect.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userEvents.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userEvents.methods.write.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userStores.methods.batchUpdateUserLicenses.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userStores.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userStores.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userStores.resources.licenseConfigsUsageStats.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userStores.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userStores.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userStores.resources.userLicenses.methods.list.scopes (Total Keys: 1) - resources.projects.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.operations.methods.list.scopes (Total Keys: 1) #### discoveryengine:v1beta The following keys were added: - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.distributeLicenseConfig (Total Keys: 12) - resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.retractLicenseConfig (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.create.parameters.sessionId (Total Keys: 2) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.create.parameters.sessionId (Total Keys: 2) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.create.parameters.sessionId (Total Keys: 2) - resources.projects.resources.locations.resources.userStores.resources.userLicenses.methods.list.parameters.filter (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1ActionConfig.properties.createBapConnection.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1Assistant.properties.createTime (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1Assistant.properties.updateTime (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1CliConfig (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1DataConnector.properties.cliConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaActionConfig.properties.createBapConnection.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaAnswer.properties.blobAttachments.readOnly (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaAssistAnswerReply.properties.createTime (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaCliConfig (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.cliConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.dataProtectionPolicy.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.customRankingParams.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.entity.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1alphaUserInfo.properties.preciseLocation.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1betaAnswer.properties.blobAttachments.readOnly (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaAssistAnswerReply.properties.createTime (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1betaAssistant.properties.createTime (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1betaAssistant.properties.updateTime (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1betaDistributeLicenseConfigRequest (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1betaDistributeLicenseConfigResponse (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1betaRetractLicenseConfigRequest (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1betaRetractLicenseConfigResponse (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.customRankingParams.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.entity.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1betaSearchResponseSearchResultRankSignals.properties.precomputedExpressionValues (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1betaUserInfo.properties.preciseLocation.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation (Total Keys: 4) - schemas.GoogleTypeLatLng (Total Keys: 6) The following keys were changed: - resources.projects.methods.provision.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.getAclConfig.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.getCmekConfig.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.obtainCrawlRate.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.removeDedicatedCrawlRate.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.setDedicatedCrawlRate.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.updateAclConfig.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.updateCmekConfig.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.cmekConfigs.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.cmekConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.cmekConfigs.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.cmekConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataConnector.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataConnector.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.completeQuery.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.getSiteSearchEngine.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.trainCustomModel.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.methods.batchGetDocumentsMetadata.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.operations.methods.cancel.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.completionConfig.methods.completeQuery.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.completionSuggestions.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.completionSuggestions.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.controls.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.controls.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.controls.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.controls.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.controls.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.conversations.methods.converse.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.conversations.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.conversations.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.conversations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.conversations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.conversations.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.customModels.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.models.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.models.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.schemas.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.answer.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.recommend.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.search.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.searchLite.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.streamAnswer.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.sessions.resources.answers.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.batchVerifyTargetSites.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.disableAdvancedSiteSearch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.enableAdvancedSiteSearch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.fetchDomainVerificationStatus.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.batchCreate.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.resources.targetSites.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.suggestionDenyListEntries.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.suggestionDenyListEntries.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.userEvents.methods.collect.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.userEvents.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.userEvents.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.userEvents.methods.write.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.getIamPolicy.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.pause.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.resume.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.setIamPolicy.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.methods.tune.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.methods.streamAssist.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.completeQuery.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.completionConfig.methods.removeSuggestion.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.controls.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.controls.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.controls.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.controls.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.controls.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.conversations.methods.converse.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.conversations.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.conversations.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.conversations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.conversations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.conversations.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.answer.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.searchLite.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.streamAnswer.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.resources.answers.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.collections.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.completeQuery.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.getSiteSearchEngine.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.methods.batchGetDocumentsMetadata.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.operations.methods.cancel.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.completionConfig.methods.completeQuery.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.completionSuggestions.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.completionSuggestions.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.controls.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.controls.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.controls.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.controls.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.controls.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.conversations.methods.converse.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.conversations.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.conversations.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.conversations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.conversations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.conversations.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.models.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.models.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.schemas.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.schemas.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.schemas.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.schemas.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.schemas.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.answer.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.recommend.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.search.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.searchLite.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.streamAnswer.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.sessions.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.sessions.resources.answers.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.disableAdvancedSiteSearch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.enableAdvancedSiteSearch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.sitemaps.methods.fetch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.batchCreate.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.resources.targetSites.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.suggestionDenyListEntries.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.suggestionDenyListEntries.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.userEvents.methods.collect.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.userEvents.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.userEvents.methods.purge.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataStores.resources.userEvents.methods.write.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.evaluations.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.evaluations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.evaluations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.evaluations.methods.listResults.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.evaluations.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.groundingConfigs.methods.check.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.importIdentityMappings.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.listIdentityMappings.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.methods.purgeIdentityMappings.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.identityMappingStores.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.licenseConfigs.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.licenseConfigs.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.licenseConfigs.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.podcasts.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.rankingConfigs.methods.rank.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userEvents.methods.collect.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userEvents.methods.import.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userEvents.methods.write.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userStores.methods.batchUpdateUserLicenses.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userStores.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userStores.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userStores.resources.licenseConfigsUsageStats.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.userStores.resources.userLicenses.methods.list.scopes (Total Keys: 1) - resources.projects.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.operations.methods.list.scopes (Total Keys: 1) --- ...Accounts.billingAccountLicenseConfigs.html | 199 +++ .../discoveryengine_v1.billingAccounts.html | 91 ++ docs/dyn/discoveryengine_v1.html | 5 + ...s.locations.collections.dataConnector.html | 33 + ...llections.dataStores.completionConfig.html | 7 + ....collections.dataStores.conversations.html | 3 + ...collections.dataStores.servingConfigs.html | 49 +- ...tions.collections.dataStores.sessions.html | 11 +- ...ons.collections.dataStores.userEvents.html | 21 + ....collections.dataStores.widgetConfigs.html | 6 +- ...ations.collections.engines.assistants.html | 13 + ....collections.engines.completionConfig.html | 7 + ...ons.collections.engines.conversations.html | 3 + ...rojects.locations.collections.engines.html | 10 +- ...ns.collections.engines.servingConfigs.html | 49 +- ...ocations.collections.engines.sessions.html | 11 +- ...ons.collections.engines.widgetConfigs.html | 6 +- ...ine_v1.projects.locations.collections.html | 18 + ...locations.dataStores.completionConfig.html | 7 + ...ts.locations.dataStores.conversations.html | 3 + ...s.locations.dataStores.servingConfigs.html | 49 +- ...rojects.locations.dataStores.sessions.html | 11 +- ...jects.locations.dataStores.userEvents.html | 21 + ...ts.locations.dataStores.widgetConfigs.html | 6 +- ...discoveryengine_v1.projects.locations.html | 12 + ...gine_v1.projects.locations.userEvents.html | 21 + ...cts.locations.userStores.userLicenses.html | 5 +- ...s.locations.collections.dataConnector.html | 33 + ...llections.dataStores.completionConfig.html | 7 + ....collections.dataStores.conversations.html | 3 + ...ects.locations.collections.dataStores.html | 25 + ...collections.dataStores.servingConfigs.html | 71 +- ...llections.dataStores.sessions.answers.html | 2 +- ...tions.collections.dataStores.sessions.html | 23 +- ...ons.collections.dataStores.userEvents.html | 21 + ....collections.dataStores.widgetConfigs.html | 6 +- ...ations.collections.engines.assistants.html | 13 + ....collections.engines.completionConfig.html | 14 + ...ons.collections.engines.conversations.html | 3 + ...rojects.locations.collections.engines.html | 14 +- ...ns.collections.engines.servingConfigs.html | 71 +- ....collections.engines.sessions.answers.html | 2 +- ...ocations.collections.engines.sessions.html | 23 +- ...ons.collections.engines.widgetConfigs.html | 6 +- ...1alpha.projects.locations.collections.html | 36 + ...locations.dataStores.completionConfig.html | 7 + ...ts.locations.dataStores.conversations.html | 3 + ...v1alpha.projects.locations.dataStores.html | 25 + ...s.locations.dataStores.servingConfigs.html | 71 +- ...locations.dataStores.sessions.answers.html | 2 +- ...rojects.locations.dataStores.sessions.html | 23 +- ...jects.locations.dataStores.userEvents.html | 21 + ...ts.locations.dataStores.widgetConfigs.html | 6 +- ...1alpha.projects.locations.evaluations.html | 45 +- ...veryengine_v1alpha.projects.locations.html | 12 + ...v1alpha.projects.locations.userEvents.html | 21 + ...cts.locations.userStores.userLicenses.html | 5 +- ...Accounts.billingAccountLicenseConfigs.html | 199 +++ ...iscoveryengine_v1beta.billingAccounts.html | 91 ++ docs/dyn/discoveryengine_v1beta.html | 5 + ...llections.dataStores.completionConfig.html | 7 + ....collections.dataStores.conversations.html | 3 + ...collections.dataStores.servingConfigs.html | 67 +- ...llections.dataStores.sessions.answers.html | 2 +- ...tions.collections.dataStores.sessions.html | 23 +- ...ons.collections.dataStores.userEvents.html | 21 + ...ations.collections.engines.assistants.html | 13 + ....collections.engines.completionConfig.html | 14 + ...ons.collections.engines.conversations.html | 3 + ...rojects.locations.collections.engines.html | 14 +- ...ns.collections.engines.servingConfigs.html | 67 +- ....collections.engines.sessions.answers.html | 2 +- ...ocations.collections.engines.sessions.html | 23 +- ...locations.dataStores.completionConfig.html | 7 + ...ts.locations.dataStores.conversations.html | 3 + ...s.locations.dataStores.servingConfigs.html | 67 +- ...locations.dataStores.sessions.answers.html | 2 +- ...rojects.locations.dataStores.sessions.html | 23 +- ...jects.locations.dataStores.userEvents.html | 21 + ...v1beta.projects.locations.evaluations.html | 45 +- ..._v1beta.projects.locations.userEvents.html | 21 + ...cts.locations.userStores.userLicenses.html | 5 +- .../documents/discoveryengine.v1.json | 1278 +++++++++++---- .../documents/discoveryengine.v1alpha.json | 1373 ++++++++++++----- .../documents/discoveryengine.v1beta.json | 1181 ++++++++++---- 85 files changed, 4746 insertions(+), 1125 deletions(-) create mode 100644 docs/dyn/discoveryengine_v1.billingAccounts.billingAccountLicenseConfigs.html create mode 100644 docs/dyn/discoveryengine_v1.billingAccounts.html create mode 100644 docs/dyn/discoveryengine_v1beta.billingAccounts.billingAccountLicenseConfigs.html create mode 100644 docs/dyn/discoveryengine_v1beta.billingAccounts.html diff --git a/docs/dyn/discoveryengine_v1.billingAccounts.billingAccountLicenseConfigs.html b/docs/dyn/discoveryengine_v1.billingAccounts.billingAccountLicenseConfigs.html new file mode 100644 index 0000000000..0e9b110d2d --- /dev/null +++ b/docs/dyn/discoveryengine_v1.billingAccounts.billingAccountLicenseConfigs.html @@ -0,0 +1,199 @@ + + + +

Discovery Engine API . billingAccounts . billingAccountLicenseConfigs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ distributeLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None)

+

Distributes a LicenseConfig from billing account level to project level.

+

+ retractLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None)

+

This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ distributeLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None) +
Distributes a LicenseConfig from billing account level to project level.
+
+Args:
+  billingAccountLicenseConfig: string, Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for LicenseConfigService.DistributeLicenseConfig method.
+  "licenseConfigId": "A String", # Optional. Distribute seats to this license config instead of creating a new one. If not specified, a new license config will be created from the billing account license config.
+  "licenseCount": "A String", # Required. The number of licenses to distribute.
+  "location": "A String", # Required. The target GCP project region to distribute the license config to.
+  "projectNumber": "A String", # Required. The target GCP project number to distribute the license config to.
+}
+
+  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 LicenseConfigService.DistributeLicenseConfig method.
+  "licenseConfig": { # Information about users' licenses. # The updated or created LicenseConfig.
+    "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+    "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+    "earlyTerminationDate": { # 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 when the subscription is terminated earlier than the expiration 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.
+    },
+    "endDate": { # 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 # Optional. The planed end 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.
+    },
+    "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+    "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle.
+    "licenseCount": "A String", # Required. Number of licenses purchased.
+    "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+    "startDate": { # 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 start 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.
+    },
+    "state": "A String", # Output only. The state of the license config.
+    "subscriptionTerm": "A String", # Required. Subscription term.
+    "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+  },
+}
+
+ +
+ retractLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None) +
This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.
+
+Args:
+  billingAccountLicenseConfig: string, Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for LicenseConfigService.RetractLicenseConfig method.
+  "fullRetract": True or False, # Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count.
+  "licenseConfig": "A String", # Required. Full resource name of LicenseConfig. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config_id}`.
+  "licenseCount": "A String", # Optional. The number of licenses to retract. Only used when full_retract is false.
+}
+
+  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 LicenseConfigService.RetractLicenseConfig method.
+  "licenseConfig": { # Information about users' licenses. # The updated LicenseConfig.
+    "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+    "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+    "earlyTerminationDate": { # 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 when the subscription is terminated earlier than the expiration 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.
+    },
+    "endDate": { # 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 # Optional. The planed end 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.
+    },
+    "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+    "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle.
+    "licenseCount": "A String", # Required. Number of licenses purchased.
+    "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+    "startDate": { # 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 start 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.
+    },
+    "state": "A String", # Output only. The state of the license config.
+    "subscriptionTerm": "A String", # Required. Subscription term.
+    "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1.billingAccounts.html b/docs/dyn/discoveryengine_v1.billingAccounts.html new file mode 100644 index 0000000000..73bf2570f8 --- /dev/null +++ b/docs/dyn/discoveryengine_v1.billingAccounts.html @@ -0,0 +1,91 @@ + + + +

Discovery Engine API . billingAccounts

+

Instance Methods

+

+ billingAccountLicenseConfigs() +

+

Returns the billingAccountLicenseConfigs Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1.html b/docs/dyn/discoveryengine_v1.html index 03947fffd7..e6ae82a5ce 100644 --- a/docs/dyn/discoveryengine_v1.html +++ b/docs/dyn/discoveryengine_v1.html @@ -74,6 +74,11 @@

Discovery Engine API

Instance Methods

+

+ billingAccounts() +

+

Returns the billingAccounts Resource.

+

projects()

diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataConnector.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataConnector.html index 21e49fe771..2efd8b9c66 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataConnector.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataConnector.html @@ -82,10 +82,43 @@

Instance Methods

close()

Close httplib2 connections.

+

+ mcp(projectsId, locationsId, collectionsId, contentType=None, data=None, extensions=None, x__xgafv=None)

+

ServeMcpDeleteRequest serves a MCP DELETE request.

Method Details

close()
Close httplib2 connections.
+
+ mcp(projectsId, locationsId, collectionsId, contentType=None, data=None, extensions=None, x__xgafv=None) +
ServeMcpDeleteRequest serves a MCP DELETE request.
+
+Args:
+  projectsId: string, A parameter (required)
+  locationsId: string, A parameter (required)
+  collectionsId: string, A parameter (required)
+  contentType: string, The HTTP Content-Type header value specifying the content type of the body.
+  data: string, The HTTP request/response body as raw binary.
+  extensions: object, Application specific response metadata. Must be set in the first response for streaming APIs. (repeated)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionConfig.html index 97aaaa455c..d5f3a17e82 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionConfig.html @@ -120,6 +120,13 @@

Method Details

"A String", ], "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html index 5079a265b5..d3479b7a99 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html @@ -466,6 +466,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html index 2c3d6200e9..d30d8a4d5d 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -122,7 +122,7 @@

Method Details

Answer query method.
 
 Args:
-  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -613,6 +613,7 @@ 

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1494,6 +1495,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -1652,6 +1660,11 @@

Method Details

"mode": "A String", # Mode to use for documents that are crowded away. }, ], + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -1682,6 +1695,7 @@

Method Details

"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results. "matchHighlightingCondition": "A String", # The condition under which match highlighting should occur. }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -1724,7 +1738,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -1764,6 +1778,13 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -1964,6 +1985,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2105,6 +2129,11 @@

Method Details

"mode": "A String", # Mode to use for documents that are crowded away. }, ], + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -2135,6 +2164,7 @@

Method Details

"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results. "matchHighlightingCondition": "A String", # The condition under which match highlighting should occur. }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -2177,7 +2207,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -2217,6 +2247,13 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -2417,6 +2454,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2518,7 +2558,7 @@

Method Details

Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.
 
 Args:
-  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -3009,6 +3049,7 @@ 

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html index f23cb0db42..0e030c69ad 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html @@ -83,7 +83,7 @@

Instance Methods

close()

Close httplib2 connections.

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

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

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.

delete(name, x__xgafv=None)

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

Method Details

- create(parent, body=None, x__xgafv=None) + create(parent, body=None, sessionId=None, x__xgafv=None)
Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
 
 Args:
@@ -295,6 +295,7 @@ 

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -375,6 +376,7 @@

Method Details

"userPseudoId": "A String", # A unique identifier for tracking users. } + sessionId: string, Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -563,6 +565,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -857,6 +860,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1139,6 +1143,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1425,6 +1430,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1694,6 +1700,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html index 24f74a3f37..676de96344 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html @@ -264,6 +264,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -463,6 +470,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -587,6 +601,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.widgetConfigs.html index f5e0ba5a79..4cf4389146 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.widgetConfigs.html @@ -301,7 +301,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -531,7 +531,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -760,7 +760,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html index fe4c01578a..ce98af7954 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html @@ -119,6 +119,7 @@

Method Details

The object takes the form of: { # Discovery Engine Assistant resource. + "createTime": "A String", # Output only. Represents the time when this Assistant was created. "customerPolicy": { # Customer-defined policy for the assistant. # Optional. Customer policy for the assistant. "bannedPhrases": [ # Optional. List of banned phrases. { # Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -157,6 +158,7 @@

Method Details

}, }, "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. } @@ -170,6 +172,7 @@

Method Details

An object of the form: { # Discovery Engine Assistant resource. + "createTime": "A String", # Output only. Represents the time when this Assistant was created. "customerPolicy": { # Customer-defined policy for the assistant. # Optional. Customer policy for the assistant. "bannedPhrases": [ # Optional. List of banned phrases. { # Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -208,6 +211,7 @@

Method Details

}, }, "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. }
@@ -245,6 +249,7 @@

Method Details

An object of the form: { # Discovery Engine Assistant resource. + "createTime": "A String", # Output only. Represents the time when this Assistant was created. "customerPolicy": { # Customer-defined policy for the assistant. # Optional. Customer policy for the assistant. "bannedPhrases": [ # Optional. List of banned phrases. { # Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -283,6 +288,7 @@

Method Details

}, }, "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. }
@@ -306,6 +312,7 @@

Method Details

{ # Response message for the AssistantService.ListAssistants method. "assistants": [ # All the customer's Assistants. { # Discovery Engine Assistant resource. + "createTime": "A String", # Output only. Represents the time when this Assistant was created. "customerPolicy": { # Customer-defined policy for the assistant. # Optional. Customer policy for the assistant. "bannedPhrases": [ # Optional. List of banned phrases. { # Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -344,6 +351,7 @@

Method Details

}, }, "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, ], @@ -375,6 +383,7 @@

Method Details

The object takes the form of: { # Discovery Engine Assistant resource. + "createTime": "A String", # Output only. Represents the time when this Assistant was created. "customerPolicy": { # Customer-defined policy for the assistant. # Optional. Customer policy for the assistant. "bannedPhrases": [ # Optional. List of banned phrases. { # Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -413,6 +422,7 @@

Method Details

}, }, "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. } @@ -426,6 +436,7 @@

Method Details

An object of the form: { # Discovery Engine Assistant resource. + "createTime": "A String", # Output only. Represents the time when this Assistant was created. "customerPolicy": { # Customer-defined policy for the assistant. # Optional. Customer policy for the assistant. "bannedPhrases": [ # Optional. List of banned phrases. { # Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -464,6 +475,7 @@

Method Details

}, }, "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. }
@@ -570,6 +582,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.completionConfig.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.completionConfig.html index 3a60d52ef0..0e2b606a83 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.completionConfig.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.completionConfig.html @@ -120,6 +120,13 @@

Method Details

"A String", ], "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.conversations.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.conversations.html index 93a504271b..2172a694d6 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.conversations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.conversations.html @@ -466,6 +466,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html index 096939ad42..137e524782 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html @@ -203,7 +203,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -389,7 +389,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -551,7 +551,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -685,7 +685,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -801,7 +801,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html index 2a43c3c148..5dad2c3291 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -122,7 +122,7 @@

Method Details

Answer query method.
 
 Args:
-  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -613,6 +613,7 @@ 

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1494,6 +1495,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -1652,6 +1660,11 @@

Method Details

"mode": "A String", # Mode to use for documents that are crowded away. }, ], + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -1682,6 +1695,7 @@

Method Details

"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results. "matchHighlightingCondition": "A String", # The condition under which match highlighting should occur. }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -1724,7 +1738,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -1764,6 +1778,13 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -1964,6 +1985,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2105,6 +2129,11 @@

Method Details

"mode": "A String", # Mode to use for documents that are crowded away. }, ], + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -2135,6 +2164,7 @@

Method Details

"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results. "matchHighlightingCondition": "A String", # The condition under which match highlighting should occur. }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -2177,7 +2207,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -2217,6 +2247,13 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -2417,6 +2454,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2518,7 +2558,7 @@

Method Details

Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.
 
 Args:
-  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -3009,6 +3049,7 @@ 

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html index d9ea70d05e..2811402d68 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html @@ -83,7 +83,7 @@

Instance Methods

close()

Close httplib2 connections.

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

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

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.

delete(name, x__xgafv=None)

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

Method Details

- create(parent, body=None, x__xgafv=None) + create(parent, body=None, sessionId=None, x__xgafv=None)
Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
 
 Args:
@@ -295,6 +295,7 @@ 

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -375,6 +376,7 @@

Method Details

"userPseudoId": "A String", # A unique identifier for tracking users. } + sessionId: string, Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -563,6 +565,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -857,6 +860,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1139,6 +1143,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1425,6 +1430,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1694,6 +1700,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.widgetConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.widgetConfigs.html index 2f946188fa..57d803322a 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.widgetConfigs.html @@ -301,7 +301,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -531,7 +531,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -760,7 +760,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.html index b431e6de95..a1a2ea5b88 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.html @@ -167,6 +167,7 @@

Method Details

"actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, + "createBapConnection": True or False, # Optional. Whether to create a BAP connection for the connector. "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. @@ -203,6 +204,11 @@

Method Details

"blockingReasons": [ # Output only. User actions that must be completed before the connector can start syncing data. "A String", ], + "cliConfig": { # The configuration for the CLI execution based connectors. # Optional. The configuration for establishing a CLI connection. + "enabledActions": [ # Optional. The actions enabled on the associated CLI connection. + "A String", + ], + }, "connectorModes": [ # Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. "A String", ], @@ -388,6 +394,7 @@

Method Details

"actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, + "createBapConnection": True or False, # Optional. Whether to create a BAP connection for the connector. "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. @@ -424,6 +431,11 @@

Method Details

"blockingReasons": [ # Output only. User actions that must be completed before the connector can start syncing data. "A String", ], + "cliConfig": { # The configuration for the CLI execution based connectors. # Optional. The configuration for establishing a CLI connection. + "enabledActions": [ # Optional. The actions enabled on the associated CLI connection. + "A String", + ], + }, "connectorModes": [ # Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. "A String", ], @@ -608,6 +620,7 @@

Method Details

"actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, + "createBapConnection": True or False, # Optional. Whether to create a BAP connection for the connector. "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. @@ -644,6 +657,11 @@

Method Details

"blockingReasons": [ # Output only. User actions that must be completed before the connector can start syncing data. "A String", ], + "cliConfig": { # The configuration for the CLI execution based connectors. # Optional. The configuration for establishing a CLI connection. + "enabledActions": [ # Optional. The actions enabled on the associated CLI connection. + "A String", + ], + }, "connectorModes": [ # Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. "A String", ], diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionConfig.html index c7c07f378b..df48afb344 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionConfig.html @@ -120,6 +120,13 @@

Method Details

"A String", ], "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.conversations.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.conversations.html index e74ddafec5..adba6464e8 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.conversations.html @@ -466,6 +466,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index 3bb6bedd25..41fe4d7a35 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html @@ -122,7 +122,7 @@

Method Details

Answer query method.
 
 Args:
-  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -613,6 +613,7 @@ 

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1494,6 +1495,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -1652,6 +1660,11 @@

Method Details

"mode": "A String", # Mode to use for documents that are crowded away. }, ], + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -1682,6 +1695,7 @@

Method Details

"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results. "matchHighlightingCondition": "A String", # The condition under which match highlighting should occur. }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -1724,7 +1738,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -1764,6 +1778,13 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -1964,6 +1985,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2105,6 +2129,11 @@

Method Details

"mode": "A String", # Mode to use for documents that are crowded away. }, ], + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -2135,6 +2164,7 @@

Method Details

"displaySpec": { # Specifies features for display, like match highlighting. # Optional. Config for display feature, like match highlighting on search results. "matchHighlightingCondition": "A String", # The condition under which match highlighting should occur. }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -2177,7 +2207,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -2217,6 +2247,13 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -2417,6 +2454,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2518,7 +2558,7 @@

Method Details

Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.
 
 Args:
-  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -3009,6 +3049,7 @@ 

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html index 010b2d499d..96c28c46c7 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.html @@ -83,7 +83,7 @@

Instance Methods

close()

Close httplib2 connections.

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

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

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.

delete(name, x__xgafv=None)

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

Method Details

- create(parent, body=None, x__xgafv=None) + create(parent, body=None, sessionId=None, x__xgafv=None)
Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
 
 Args:
@@ -295,6 +295,7 @@ 

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -375,6 +376,7 @@

Method Details

"userPseudoId": "A String", # A unique identifier for tracking users. } + sessionId: string, Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -563,6 +565,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -857,6 +860,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1139,6 +1143,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1425,6 +1430,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1694,6 +1700,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html index d96d21615c..9be17c91d3 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html @@ -264,6 +264,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -463,6 +470,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -587,6 +601,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html index c688146b85..96ae50edbc 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html @@ -301,7 +301,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -531,7 +531,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -760,7 +760,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.html b/docs/dyn/discoveryengine_v1.projects.locations.html index 7a0c4b6cd9..327234d133 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.html @@ -229,6 +229,7 @@

Method Details

"actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, + "createBapConnection": True or False, # Optional. Whether to create a BAP connection for the connector. "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. @@ -265,6 +266,11 @@

Method Details

"blockingReasons": [ # Output only. User actions that must be completed before the connector can start syncing data. "A String", ], + "cliConfig": { # The configuration for the CLI execution based connectors. # Optional. The configuration for establishing a CLI connection. + "enabledActions": [ # Optional. The actions enabled on the associated CLI connection. + "A String", + ], + }, "connectorModes": [ # Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. "A String", ], @@ -479,6 +485,7 @@

Method Details

"actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, + "createBapConnection": True or False, # Optional. Whether to create a BAP connection for the connector. "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. @@ -515,6 +522,11 @@

Method Details

"blockingReasons": [ # Output only. User actions that must be completed before the connector can start syncing data. "A String", ], + "cliConfig": { # The configuration for the CLI execution based connectors. # Optional. The configuration for establishing a CLI connection. + "enabledActions": [ # Optional. The actions enabled on the associated CLI connection. + "A String", + ], + }, "connectorModes": [ # Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. "A String", ], diff --git a/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html index 87eb4a2c73..ac5eec3214 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.userEvents.html @@ -261,6 +261,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -417,6 +424,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -541,6 +555,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.userStores.userLicenses.html b/docs/dyn/discoveryengine_v1.projects.locations.userStores.userLicenses.html index 17f28b64a1..88f641ad76 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.userStores.userLicenses.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.userStores.userLicenses.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

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

Lists the User Licenses.

list_next()

@@ -90,11 +90,12 @@

Method Details

- list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the User Licenses.
 
 Args:
   parent: string, Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. (required)
+  filter: string, Optional. Filter for the list request. Supported fields: * `license_assignment_state` * `user_principal` * Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned. * `user_principal = user1@abc.com` to list user license for `user1@abc.com`.
   orderBy: string, Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. Redundant space characters in the syntax are insignificant. Supported fields (only `user_principal` is supported for now): * `user_principal` If not set, the default ordering is by `user_principal`. Examples: * `user_principal` to order by `user_principal` in ascending order. * `user_principal desc` to order by `user_principal` in descending order.
   pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.
   pageToken: string, Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.html
index ab96a28061..39e5e07049 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataConnector.html
@@ -96,6 +96,9 @@ 

Instance Methods

getConnectorSecret(name, x__xgafv=None)

Get the secret for the associated connector.

+

+ mcp(projectsId, locationsId, collectionsId, contentType=None, data=None, extensions=None, x__xgafv=None)

+

ServeMcpDeleteRequest serves a MCP DELETE request.

startConnectorRun(parent, body=None, x__xgafv=None)

Starts an immediate synchronization process for a DataConnector. Third Party Connector Users must specify which entities should be synced. FHIR Connectors must provide a timestamp to indicate the point in time from which data should be synced.

@@ -184,6 +187,36 @@

Method Details

}
+
+ mcp(projectsId, locationsId, collectionsId, contentType=None, data=None, extensions=None, x__xgafv=None) +
ServeMcpDeleteRequest serves a MCP DELETE request.
+
+Args:
+  projectsId: string, A parameter (required)
+  locationsId: string, A parameter (required)
+  collectionsId: string, A parameter (required)
+  contentType: string, The HTTP Content-Type header value specifying the content type of the body.
+  data: string, The HTTP request/response body as raw binary.
+  extensions: object, Application specific response metadata. Must be set in the first response for streaming APIs. (repeated)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+
startConnectorRun(parent, body=None, x__xgafv=None)
Starts an immediate synchronization process for a DataConnector. Third Party Connector Users must specify which entities should be synced. FHIR Connectors must provide a timestamp to indicate the point in time from which data should be synced.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html
index 6040806672..c54ac8e68d 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html
@@ -120,6 +120,13 @@ 

Method Details

"A String", ], "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html index f014650022..819640fefc 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html @@ -535,6 +535,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html index 1f38a6a9ac..0979c69a6f 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html @@ -320,6 +320,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -640,6 +645,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -957,6 +967,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -1179,6 +1194,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -1383,6 +1403,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html index 546864a182..e3e8181b3a 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -122,7 +122,7 @@

Method Details

Answer query method.
 
 Args:
-  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -245,7 +245,7 @@ 

Method Details

}, ], }, - "customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. + "customFineTuningSpec": { # Defines custom fine tuning spec. # Optional. Custom fine tuning configs. "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model. }, "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. @@ -283,7 +283,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -349,7 +349,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -514,7 +514,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -691,6 +691,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1707,6 +1708,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -1871,6 +1879,11 @@

Method Details

"customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model. }, + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -1911,6 +1924,7 @@

Method Details

}, ], }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -1953,7 +1967,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -2014,6 +2028,13 @@

Method Details

}, "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -2232,6 +2253,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2359,6 +2383,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2519,6 +2546,11 @@

Method Details

"customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model. }, + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -2559,6 +2591,7 @@

Method Details

}, ], }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -2601,7 +2634,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -2662,6 +2695,13 @@

Method Details

}, "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -2880,6 +2920,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -3007,6 +3050,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -3121,7 +3167,7 @@

Method Details

Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.
 
 Args:
-  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -3244,7 +3290,7 @@ 

Method Details

}, ], }, - "customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. + "customFineTuningSpec": { # Defines custom fine tuning spec. # Optional. Custom fine tuning configs. "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model. }, "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. @@ -3282,7 +3328,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -3348,7 +3394,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -3513,7 +3559,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -3690,6 +3736,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html index 6542b9beea..cabc9f4056 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html @@ -105,7 +105,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html index 9242cf79e1..8574bf3173 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html @@ -83,7 +83,7 @@

Instance Methods

close()

Close httplib2 connections.

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

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

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.

delete(name, x__xgafv=None)

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

Method Details

- create(parent, body=None, x__xgafv=None) + create(parent, body=None, sessionId=None, x__xgafv=None)
Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
 
 Args:
@@ -133,7 +133,7 @@ 

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -310,6 +310,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -423,6 +424,7 @@

Method Details

"userPseudoId": "A String", # A unique identifier for tracking users. } + sessionId: string, Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -449,7 +451,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -626,6 +628,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -791,7 +794,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -968,6 +971,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1121,7 +1125,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -1298,6 +1302,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1455,7 +1460,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -1632,6 +1637,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1772,7 +1778,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -1949,6 +1955,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html index d2b939d7c9..306613c87e 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html @@ -264,6 +264,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -463,6 +470,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -587,6 +601,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html index 569a585e08..67ded06c7c 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html @@ -306,7 +306,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -546,7 +546,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -785,7 +785,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html index d8fb4b95ab..fe6b0bb60b 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html @@ -124,6 +124,7 @@

Method Details

The object takes the form of: { # Discovery Engine Assistant resource. + "createTime": "A String", # Output only. Represents the time when this Assistant was created. "customerPolicy": { # Customer-defined policy for the assistant. # Optional. Customer policy for the assistant. "bannedPhrases": [ # Optional. List of banned phrases. { # Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -163,6 +164,7 @@

Method Details

}, }, "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. } @@ -176,6 +178,7 @@

Method Details

An object of the form: { # Discovery Engine Assistant resource. + "createTime": "A String", # Output only. Represents the time when this Assistant was created. "customerPolicy": { # Customer-defined policy for the assistant. # Optional. Customer policy for the assistant. "bannedPhrases": [ # Optional. List of banned phrases. { # Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -215,6 +218,7 @@

Method Details

}, }, "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. }
@@ -252,6 +256,7 @@

Method Details

An object of the form: { # Discovery Engine Assistant resource. + "createTime": "A String", # Output only. Represents the time when this Assistant was created. "customerPolicy": { # Customer-defined policy for the assistant. # Optional. Customer policy for the assistant. "bannedPhrases": [ # Optional. List of banned phrases. { # Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -291,6 +296,7 @@

Method Details

}, }, "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. }
@@ -314,6 +320,7 @@

Method Details

{ # Response message for the AssistantService.ListAssistants method. "assistants": [ # All the customer's Assistants. { # Discovery Engine Assistant resource. + "createTime": "A String", # Output only. Represents the time when this Assistant was created. "customerPolicy": { # Customer-defined policy for the assistant. # Optional. Customer policy for the assistant. "bannedPhrases": [ # Optional. List of banned phrases. { # Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -353,6 +360,7 @@

Method Details

}, }, "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, ], @@ -384,6 +392,7 @@

Method Details

The object takes the form of: { # Discovery Engine Assistant resource. + "createTime": "A String", # Output only. Represents the time when this Assistant was created. "customerPolicy": { # Customer-defined policy for the assistant. # Optional. Customer policy for the assistant. "bannedPhrases": [ # Optional. List of banned phrases. { # Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -423,6 +432,7 @@

Method Details

}, }, "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. } @@ -436,6 +446,7 @@

Method Details

An object of the form: { # Discovery Engine Assistant resource. + "createTime": "A String", # Output only. Represents the time when this Assistant was created. "customerPolicy": { # Customer-defined policy for the assistant. # Optional. Customer policy for the assistant. "bannedPhrases": [ # Optional. List of banned phrases. { # Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -475,6 +486,7 @@

Method Details

}, }, "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. }
@@ -616,6 +628,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html index a5bd30f7f0..578d8414c1 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html @@ -123,6 +123,13 @@

Method Details

"A String", ], "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -292,6 +299,13 @@

Method Details

"removeTime": "A String", # Required. Time at which the suggestion was removed. If not set, the current time will be used. "searchHistorySuggestion": "A String", # The search history suggestion to be removed. "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html index 30ca974f5c..7b4c8d8e9b 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html @@ -535,6 +535,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html index d30577149e..26855a95d7 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html @@ -220,7 +220,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -415,7 +415,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -605,7 +605,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -748,7 +748,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -873,7 +873,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -1010,7 +1010,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -1147,7 +1147,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html index 6b53a5735c..1dbb66d56b 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -122,7 +122,7 @@

Method Details

Answer query method.
 
 Args:
-  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -245,7 +245,7 @@ 

Method Details

}, ], }, - "customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. + "customFineTuningSpec": { # Defines custom fine tuning spec. # Optional. Custom fine tuning configs. "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model. }, "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. @@ -283,7 +283,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -349,7 +349,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -514,7 +514,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -691,6 +691,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1707,6 +1708,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -1871,6 +1879,11 @@

Method Details

"customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model. }, + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -1911,6 +1924,7 @@

Method Details

}, ], }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -1953,7 +1967,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -2014,6 +2028,13 @@

Method Details

}, "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -2232,6 +2253,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2359,6 +2383,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2519,6 +2546,11 @@

Method Details

"customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model. }, + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -2559,6 +2591,7 @@

Method Details

}, ], }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -2601,7 +2634,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -2662,6 +2695,13 @@

Method Details

}, "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -2880,6 +2920,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -3007,6 +3050,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -3121,7 +3167,7 @@

Method Details

Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.
 
 Args:
-  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -3244,7 +3290,7 @@ 

Method Details

}, ], }, - "customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. + "customFineTuningSpec": { # Defines custom fine tuning spec. # Optional. Custom fine tuning configs. "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model. }, "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. @@ -3282,7 +3328,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -3348,7 +3394,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -3513,7 +3559,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -3690,6 +3736,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html index 78ef1b7a20..2ca33a5fbe 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html @@ -105,7 +105,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html index c49ffefb6a..2100b0f770 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html @@ -98,7 +98,7 @@

Instance Methods

close()

Close httplib2 connections.

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

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

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.

delete(name, x__xgafv=None)

@@ -122,7 +122,7 @@

Method Details

- create(parent, body=None, x__xgafv=None) + create(parent, body=None, sessionId=None, x__xgafv=None)
Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
 
 Args:
@@ -148,7 +148,7 @@ 

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -325,6 +325,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -438,6 +439,7 @@

Method Details

"userPseudoId": "A String", # A unique identifier for tracking users. } + sessionId: string, Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -464,7 +466,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -641,6 +643,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -806,7 +809,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -983,6 +986,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1136,7 +1140,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -1313,6 +1317,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1470,7 +1475,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -1647,6 +1652,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1787,7 +1793,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -1964,6 +1970,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html index 9eee726eb1..fe989ae5a7 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html @@ -306,7 +306,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -546,7 +546,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -785,7 +785,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html index f316915393..d96d69a152 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html @@ -181,6 +181,7 @@

Method Details

"actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, + "createBapConnection": True or False, # Optional. Whether to create a BAP connection for the connector. "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. @@ -217,6 +218,11 @@

Method Details

"blockingReasons": [ # Output only. User actions that must be completed before the connector can start syncing data. "A String", ], + "cliConfig": { # The configuration for the CLI execution based connectors. # Optional. The configuration for establishing a CLI connection. + "enabledActions": [ # Optional. The actions enabled on the associated CLI connection. + "A String", + ], + }, "connectorModes": [ # Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. "A String", ], @@ -436,6 +442,7 @@

Method Details

"actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, + "createBapConnection": True or False, # Optional. Whether to create a BAP connection for the connector. "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. @@ -472,6 +479,11 @@

Method Details

"blockingReasons": [ # Output only. User actions that must be completed before the connector can start syncing data. "A String", ], + "cliConfig": { # The configuration for the CLI execution based connectors. # Optional. The configuration for establishing a CLI connection. + "enabledActions": [ # Optional. The actions enabled on the associated CLI connection. + "A String", + ], + }, "connectorModes": [ # Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. "A String", ], @@ -695,6 +707,7 @@

Method Details

"actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, + "createBapConnection": True or False, # Optional. Whether to create a BAP connection for the connector. "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. @@ -731,6 +744,11 @@

Method Details

"blockingReasons": [ # Output only. User actions that must be completed before the connector can start syncing data. "A String", ], + "cliConfig": { # The configuration for the CLI execution based connectors. # Optional. The configuration for establishing a CLI connection. + "enabledActions": [ # Optional. The actions enabled on the associated CLI connection. + "A String", + ], + }, "connectorModes": [ # Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. "A String", ], @@ -964,6 +982,7 @@

Method Details

"actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, + "createBapConnection": True or False, # Optional. Whether to create a BAP connection for the connector. "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. @@ -1000,6 +1019,11 @@

Method Details

"blockingReasons": [ # Output only. User actions that must be completed before the connector can start syncing data. "A String", ], + "cliConfig": { # The configuration for the CLI execution based connectors. # Optional. The configuration for establishing a CLI connection. + "enabledActions": [ # Optional. The actions enabled on the associated CLI connection. + "A String", + ], + }, "connectorModes": [ # Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. "A String", ], @@ -1243,6 +1267,7 @@

Method Details

"actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, + "createBapConnection": True or False, # Optional. Whether to create a BAP connection for the connector. "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. @@ -1279,6 +1304,11 @@

Method Details

"blockingReasons": [ # Output only. User actions that must be completed before the connector can start syncing data. "A String", ], + "cliConfig": { # The configuration for the CLI execution based connectors. # Optional. The configuration for establishing a CLI connection. + "enabledActions": [ # Optional. The actions enabled on the associated CLI connection. + "A String", + ], + }, "connectorModes": [ # Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. "A String", ], @@ -1489,6 +1519,7 @@

Method Details

"actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, + "createBapConnection": True or False, # Optional. Whether to create a BAP connection for the connector. "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. @@ -1525,6 +1556,11 @@

Method Details

"blockingReasons": [ # Output only. User actions that must be completed before the connector can start syncing data. "A String", ], + "cliConfig": { # The configuration for the CLI execution based connectors. # Optional. The configuration for establishing a CLI connection. + "enabledActions": [ # Optional. The actions enabled on the associated CLI connection. + "A String", + ], + }, "connectorModes": [ # Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. "A String", ], diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html index 790f86d11b..09f83f6c49 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html @@ -120,6 +120,13 @@

Method Details

"A String", ], "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html index f11367cf4d..9fba903b20 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html @@ -535,6 +535,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html index cfdcac5138..e24820a542 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html @@ -312,6 +312,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -632,6 +637,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -949,6 +959,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -1171,6 +1186,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. @@ -1375,6 +1395,11 @@

Method Details

"configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. + "dataProtectionPolicy": { # Contains the data protection policy config for a DataStore or a connector. # Optional. Specifies the data protection policy for the data store. + "sensitiveDataProtectionPolicy": { # Specifies a Sensitive Data Protection (https://cloud.google.com/sensitive-data-protection/docs/sensitive-data-protection-overview) policy. # Optional. Specifies the sensitive data protection policy for the connector source. + "policy": "A String", # Optional. Specifies the resource name of the Sensitive Data Protection content policy. + }, + }, "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. "displayName": "A String", # Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. "documentProcessingConfig": { # A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser. # Configuration for Document understanding and enrichment. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index 8f1c90893f..75c5d3302e 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -122,7 +122,7 @@

Method Details

Answer query method.
 
 Args:
-  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -245,7 +245,7 @@ 

Method Details

}, ], }, - "customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. + "customFineTuningSpec": { # Defines custom fine tuning spec. # Optional. Custom fine tuning configs. "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model. }, "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. @@ -283,7 +283,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -349,7 +349,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -514,7 +514,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -691,6 +691,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1707,6 +1708,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -1871,6 +1879,11 @@

Method Details

"customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model. }, + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -1911,6 +1924,7 @@

Method Details

}, ], }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -1953,7 +1967,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -2014,6 +2028,13 @@

Method Details

}, "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -2232,6 +2253,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2359,6 +2383,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2519,6 +2546,11 @@

Method Details

"customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model. }, + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -2559,6 +2591,7 @@

Method Details

}, ], }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -2601,7 +2634,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -2662,6 +2695,13 @@

Method Details

}, "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -2880,6 +2920,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -3007,6 +3050,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -3121,7 +3167,7 @@

Method Details

Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.
 
 Args:
-  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -3244,7 +3290,7 @@ 

Method Details

}, ], }, - "customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. + "customFineTuningSpec": { # Defines custom fine tuning spec. # Optional. Custom fine tuning configs. "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model. }, "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. @@ -3282,7 +3328,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -3348,7 +3394,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -3513,7 +3559,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -3690,6 +3736,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html index 12b3765858..3a5943068f 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html @@ -105,7 +105,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html index 8888311620..5c2b5fafcd 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html @@ -83,7 +83,7 @@

Instance Methods

close()

Close httplib2 connections.

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

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

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.

delete(name, x__xgafv=None)

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

Method Details

- create(parent, body=None, x__xgafv=None) + create(parent, body=None, sessionId=None, x__xgafv=None)
Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
 
 Args:
@@ -133,7 +133,7 @@ 

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -310,6 +310,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -423,6 +424,7 @@

Method Details

"userPseudoId": "A String", # A unique identifier for tracking users. } + sessionId: string, Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -449,7 +451,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -626,6 +628,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -791,7 +794,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -968,6 +971,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1121,7 +1125,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -1298,6 +1302,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1455,7 +1460,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -1632,6 +1637,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1772,7 +1778,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -1949,6 +1955,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html index 610c17021d..22aebd8ede 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html @@ -264,6 +264,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -463,6 +470,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -587,6 +601,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html index b6373d8f12..a482db6735 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html @@ -306,7 +306,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -546,7 +546,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -785,7 +785,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html index cf52bd1986..ca8d59500d 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html @@ -212,6 +212,11 @@

Method Details

"customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model. }, + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -252,6 +257,7 @@

Method Details

}, ], }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -294,7 +300,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -355,6 +361,13 @@

Method Details

}, "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -541,6 +554,11 @@

Method Details

"customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model. }, + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -581,6 +599,7 @@

Method Details

}, ], }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -623,7 +642,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -684,6 +703,13 @@

Method Details

}, "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -846,6 +872,11 @@

Method Details

"customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model. }, + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -886,6 +917,7 @@

Method Details

}, ], }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -928,7 +960,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -989,6 +1021,13 @@

Method Details

}, "useLatestData": True or False, # Uses the Engine, ServingConfig and Control freshly read from the database. Note: this skips config cache and introduces dependency on databases, which could significantly increase the API latency. It should only be used for testing, but not serving end users. "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index 1b0d026a70..edc3f33b90 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -1048,6 +1048,7 @@

Method Details

"actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, + "createBapConnection": True or False, # Optional. Whether to create a BAP connection for the connector. "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. @@ -1084,6 +1085,11 @@

Method Details

"blockingReasons": [ # Output only. User actions that must be completed before the connector can start syncing data. "A String", ], + "cliConfig": { # The configuration for the CLI execution based connectors. # Optional. The configuration for establishing a CLI connection. + "enabledActions": [ # Optional. The actions enabled on the associated CLI connection. + "A String", + ], + }, "connectorModes": [ # Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. "A String", ], @@ -1324,6 +1330,7 @@

Method Details

"actionParams": { # Optional. Action parameters in structured json format. "a_key": "", # Properties of the object. }, + "createBapConnection": True or False, # Optional. Whether to create a BAP connection for the connector. "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions. "jsonActionParams": "A String", # Optional. Action parameters in json string format. "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. @@ -1360,6 +1367,11 @@

Method Details

"blockingReasons": [ # Output only. User actions that must be completed before the connector can start syncing data. "A String", ], + "cliConfig": { # The configuration for the CLI execution based connectors. # Optional. The configuration for establishing a CLI connection. + "enabledActions": [ # Optional. The actions enabled on the associated CLI connection. + "A String", + ], + }, "connectorModes": [ # Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. "A String", ], diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html index 8d759010b5..5fa34f9e91 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.userEvents.html @@ -261,6 +261,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -417,6 +424,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -541,6 +555,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.userLicenses.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.userLicenses.html index 6ddc86d944..7425de9339 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.userLicenses.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.userLicenses.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

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

Lists the User Licenses.

list_next()

@@ -90,11 +90,12 @@

Method Details

- list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the User Licenses.
 
 Args:
   parent: string, Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. (required)
+  filter: string, Optional. Filter for the list request. Supported fields: * `license_assignment_state` * `user_principal` * Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned. * `user_principal = user1@abc.com` to list user license for `user1@abc.com`.
   orderBy: string, Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. Redundant space characters in the syntax are insignificant. Supported fields (only `user_principal` is supported for now): * `user_principal` If not set, the default ordering is by `user_principal`. Examples: * `user_principal` to order by `user_principal` in ascending order. * `user_principal desc` to order by `user_principal` in descending order.
   pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.
   pageToken: string, Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token.
diff --git a/docs/dyn/discoveryengine_v1beta.billingAccounts.billingAccountLicenseConfigs.html b/docs/dyn/discoveryengine_v1beta.billingAccounts.billingAccountLicenseConfigs.html
new file mode 100644
index 0000000000..5397385e8c
--- /dev/null
+++ b/docs/dyn/discoveryengine_v1beta.billingAccounts.billingAccountLicenseConfigs.html
@@ -0,0 +1,199 @@
+
+
+
+

Discovery Engine API . billingAccounts . billingAccountLicenseConfigs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ distributeLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None)

+

Distributes a LicenseConfig from billing account level to project level.

+

+ retractLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None)

+

This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ distributeLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None) +
Distributes a LicenseConfig from billing account level to project level.
+
+Args:
+  billingAccountLicenseConfig: string, Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for LicenseConfigService.DistributeLicenseConfig method.
+  "licenseConfigId": "A String", # Optional. Distribute seats to this license config instead of creating a new one. If not specified, a new license config will be created from the billing account license config.
+  "licenseCount": "A String", # Required. The number of licenses to distribute.
+  "location": "A String", # Required. The target GCP project region to distribute the license config to.
+  "projectNumber": "A String", # Required. The target GCP project number to distribute the license config to.
+}
+
+  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 LicenseConfigService.DistributeLicenseConfig method.
+  "licenseConfig": { # Information about users' licenses. # The updated or created LicenseConfig.
+    "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+    "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+    "earlyTerminationDate": { # 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 when the subscription is terminated earlier than the expiration 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.
+    },
+    "endDate": { # 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 # Optional. The planed end 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.
+    },
+    "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+    "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle.
+    "licenseCount": "A String", # Required. Number of licenses purchased.
+    "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+    "startDate": { # 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 start 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.
+    },
+    "state": "A String", # Output only. The state of the license config.
+    "subscriptionTerm": "A String", # Required. Subscription term.
+    "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+  },
+}
+
+ +
+ retractLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None) +
This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.
+
+Args:
+  billingAccountLicenseConfig: string, Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for LicenseConfigService.RetractLicenseConfig method.
+  "fullRetract": True or False, # Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count.
+  "licenseConfig": "A String", # Required. Full resource name of LicenseConfig. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config_id}`.
+  "licenseCount": "A String", # Optional. The number of licenses to retract. Only used when full_retract is false.
+}
+
+  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 LicenseConfigService.RetractLicenseConfig method.
+  "licenseConfig": { # Information about users' licenses. # The updated LicenseConfig.
+    "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+    "earlyTerminated": True or False, # Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
+    "earlyTerminationDate": { # 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 when the subscription is terminated earlier than the expiration 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.
+    },
+    "endDate": { # 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 # Optional. The planed end 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.
+    },
+    "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+    "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle.
+    "licenseCount": "A String", # Required. Number of licenses purchased.
+    "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+    "startDate": { # 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 start 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.
+    },
+    "state": "A String", # Output only. The state of the license config.
+    "subscriptionTerm": "A String", # Required. Subscription term.
+    "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.billingAccounts.html b/docs/dyn/discoveryengine_v1beta.billingAccounts.html new file mode 100644 index 0000000000..84354d68d9 --- /dev/null +++ b/docs/dyn/discoveryengine_v1beta.billingAccounts.html @@ -0,0 +1,91 @@ + + + +

Discovery Engine API . billingAccounts

+

Instance Methods

+

+ billingAccountLicenseConfigs() +

+

Returns the billingAccountLicenseConfigs Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.html b/docs/dyn/discoveryengine_v1beta.html index 702454f643..16fd661ae9 100644 --- a/docs/dyn/discoveryengine_v1beta.html +++ b/docs/dyn/discoveryengine_v1beta.html @@ -74,6 +74,11 @@

Discovery Engine API

Instance Methods

+

+ billingAccounts() +

+

Returns the billingAccounts Resource.

+

projects()

diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html index 40ddb86c64..a3c897035c 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html @@ -120,6 +120,13 @@

Method Details

"A String", ], "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html index eba7bc835b..515cdea621 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html @@ -535,6 +535,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html index a02f93fe8e..94c2b38fa0 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -122,7 +122,7 @@

Method Details

Answer query method.
 
 Args:
-  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -248,7 +248,7 @@ 

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -314,7 +314,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -479,7 +479,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -656,6 +656,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1591,6 +1592,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -1752,6 +1760,11 @@

Method Details

"mode": "A String", # Mode to use for documents that are crowded away. }, ], + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -1792,6 +1805,7 @@

Method Details

}, ], }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -1834,7 +1848,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -1894,6 +1908,13 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -2112,6 +2133,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2239,6 +2263,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2396,6 +2423,11 @@

Method Details

"mode": "A String", # Mode to use for documents that are crowded away. }, ], + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -2436,6 +2468,7 @@

Method Details

}, ], }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -2478,7 +2511,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -2538,6 +2571,13 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -2756,6 +2796,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2883,6 +2926,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2997,7 +3043,7 @@

Method Details

Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.
 
 Args:
-  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -3123,7 +3169,7 @@ 

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -3189,7 +3235,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -3354,7 +3400,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -3531,6 +3577,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html index 8bd3e070b8..c548f2625f 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html @@ -105,7 +105,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html index a1ae9cf4b3..73bce383c3 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html @@ -83,7 +83,7 @@

Instance Methods

close()

Close httplib2 connections.

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

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

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.

delete(name, x__xgafv=None)

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

Method Details

- create(parent, body=None, x__xgafv=None) + create(parent, body=None, sessionId=None, x__xgafv=None)
Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
 
 Args:
@@ -133,7 +133,7 @@ 

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -310,6 +310,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -390,6 +391,7 @@

Method Details

"userPseudoId": "A String", # A unique identifier for tracking users. } + sessionId: string, Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -416,7 +418,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -593,6 +595,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -725,7 +728,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -902,6 +905,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1022,7 +1026,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -1199,6 +1203,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1323,7 +1328,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -1500,6 +1505,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1607,7 +1613,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -1784,6 +1790,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html index cf858e3732..4f88403576 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html @@ -264,6 +264,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -463,6 +470,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -587,6 +601,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html index a0ec3226e2..27dd2d8aa6 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html @@ -119,6 +119,7 @@

Method Details

The object takes the form of: { # Discovery Engine Assistant resource. + "createTime": "A String", # Output only. Represents the time when this Assistant was created. "customerPolicy": { # Customer-defined policy for the assistant. # Optional. Customer policy for the assistant. "bannedPhrases": [ # Optional. List of banned phrases. { # Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -157,6 +158,7 @@

Method Details

}, }, "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. } @@ -170,6 +172,7 @@

Method Details

An object of the form: { # Discovery Engine Assistant resource. + "createTime": "A String", # Output only. Represents the time when this Assistant was created. "customerPolicy": { # Customer-defined policy for the assistant. # Optional. Customer policy for the assistant. "bannedPhrases": [ # Optional. List of banned phrases. { # Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -208,6 +211,7 @@

Method Details

}, }, "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. }
@@ -245,6 +249,7 @@

Method Details

An object of the form: { # Discovery Engine Assistant resource. + "createTime": "A String", # Output only. Represents the time when this Assistant was created. "customerPolicy": { # Customer-defined policy for the assistant. # Optional. Customer policy for the assistant. "bannedPhrases": [ # Optional. List of banned phrases. { # Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -283,6 +288,7 @@

Method Details

}, }, "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. }
@@ -306,6 +312,7 @@

Method Details

{ # Response message for the AssistantService.ListAssistants method. "assistants": [ # All the customer's Assistants. { # Discovery Engine Assistant resource. + "createTime": "A String", # Output only. Represents the time when this Assistant was created. "customerPolicy": { # Customer-defined policy for the assistant. # Optional. Customer policy for the assistant. "bannedPhrases": [ # Optional. List of banned phrases. { # Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -344,6 +351,7 @@

Method Details

}, }, "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. }, ], @@ -375,6 +383,7 @@

Method Details

The object takes the form of: { # Discovery Engine Assistant resource. + "createTime": "A String", # Output only. Represents the time when this Assistant was created. "customerPolicy": { # Customer-defined policy for the assistant. # Optional. Customer policy for the assistant. "bannedPhrases": [ # Optional. List of banned phrases. { # Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -413,6 +422,7 @@

Method Details

}, }, "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. } @@ -426,6 +436,7 @@

Method Details

An object of the form: { # Discovery Engine Assistant resource. + "createTime": "A String", # Output only. Represents the time when this Assistant was created. "customerPolicy": { # Customer-defined policy for the assistant. # Optional. Customer policy for the assistant. "bannedPhrases": [ # Optional. List of banned phrases. { # Definition of a customer-defined banned phrase. A banned phrase is not allowed to appear in the user query or the LLM response, or else the answer will be refused. @@ -464,6 +475,7 @@

Method Details

}, }, "name": "A String", # Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. + "updateTime": "A String", # Output only. Represents the time when this Assistant was most recently updated. "webGroundingType": "A String", # Optional. The type of web grounding to use. }
@@ -570,6 +582,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html index 54985cc20a..bdcfd3cb07 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html @@ -123,6 +123,13 @@

Method Details

"A String", ], "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -292,6 +299,13 @@

Method Details

"removeTime": "A String", # Required. Time at which the suggestion was removed. If not set, the current time will be used. "searchHistorySuggestion": "A String", # The search history suggestion to be removed. "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html index 9748690062..298a78f80d 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html @@ -535,6 +535,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html index d69a9f131d..aee66bba40 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html @@ -207,7 +207,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -393,7 +393,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -555,7 +555,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -689,7 +689,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -805,7 +805,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -933,7 +933,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -1061,7 +1061,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html index 355ac098e3..c9057588d0 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -122,7 +122,7 @@

Method Details

Answer query method.
 
 Args:
-  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -248,7 +248,7 @@ 

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -314,7 +314,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -479,7 +479,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -656,6 +656,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1591,6 +1592,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -1752,6 +1760,11 @@

Method Details

"mode": "A String", # Mode to use for documents that are crowded away. }, ], + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -1792,6 +1805,7 @@

Method Details

}, ], }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -1834,7 +1848,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -1894,6 +1908,13 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -2112,6 +2133,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2239,6 +2263,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2396,6 +2423,11 @@

Method Details

"mode": "A String", # Mode to use for documents that are crowded away. }, ], + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -2436,6 +2468,7 @@

Method Details

}, ], }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -2478,7 +2511,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -2538,6 +2571,13 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -2756,6 +2796,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2883,6 +2926,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2997,7 +3043,7 @@

Method Details

Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.
 
 Args:
-  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -3123,7 +3169,7 @@ 

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -3189,7 +3235,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -3354,7 +3400,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -3531,6 +3577,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html index c375a56741..99273f91ef 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html @@ -105,7 +105,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html index 17b5c448b0..80e51957d0 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html @@ -83,7 +83,7 @@

Instance Methods

close()

Close httplib2 connections.

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

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

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.

delete(name, x__xgafv=None)

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

Method Details

- create(parent, body=None, x__xgafv=None) + create(parent, body=None, sessionId=None, x__xgafv=None)
Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
 
 Args:
@@ -133,7 +133,7 @@ 

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -310,6 +310,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -390,6 +391,7 @@

Method Details

"userPseudoId": "A String", # A unique identifier for tracking users. } + sessionId: string, Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -416,7 +418,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -593,6 +595,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -725,7 +728,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -902,6 +905,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1022,7 +1026,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -1199,6 +1203,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1323,7 +1328,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -1500,6 +1505,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1607,7 +1613,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -1784,6 +1790,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html index ec49b07545..baf883aeb2 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html @@ -120,6 +120,13 @@

Method Details

"A String", ], "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html index 4903cfbb8f..0edf802ba8 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html @@ -535,6 +535,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index 51ba50f279..d534e80d8d 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -122,7 +122,7 @@

Method Details

Answer query method.
 
 Args:
-  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -248,7 +248,7 @@ 

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -314,7 +314,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -479,7 +479,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -656,6 +656,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1591,6 +1592,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -1752,6 +1760,11 @@

Method Details

"mode": "A String", # Mode to use for documents that are crowded away. }, ], + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -1792,6 +1805,7 @@

Method Details

}, ], }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -1834,7 +1848,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -1894,6 +1908,13 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -2112,6 +2133,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2239,6 +2263,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2396,6 +2423,11 @@

Method Details

"mode": "A String", # Mode to use for documents that are crowded away. }, ], + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -2436,6 +2468,7 @@

Method Details

}, ], }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -2478,7 +2511,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -2538,6 +2571,13 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -2756,6 +2796,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2883,6 +2926,9 @@

Method Details

"documentAge": 3.14, # Optional. Age of the document in hours. "keywordSimilarityScore": 3.14, # Optional. Keyword matching adjustment. "pctrRank": 3.14, # Optional. Predicted conversion rate adjustment as a rank. + "precomputedExpressionValues": [ # Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`. + 3.14, + ], "relevanceScore": 3.14, # Optional. Semantic relevance adjustment. "semanticSimilarityScore": 3.14, # Optional. Semantic similarity adjustment. "topicalityRank": 3.14, # Optional. Topicality adjustment as a rank. @@ -2997,7 +3043,7 @@

Method Details

Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.
 
 Args:
-  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  servingConfig: string, Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -3123,7 +3169,7 @@ 

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -3189,7 +3235,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -3354,7 +3400,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -3531,6 +3577,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html index 776d08a0ee..1230b1c24a 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html @@ -105,7 +105,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html index d4df0aca81..0f7d2ab376 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html @@ -83,7 +83,7 @@

Instance Methods

close()

Close httplib2 connections.

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

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

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.

delete(name, x__xgafv=None)

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

Method Details

- create(parent, body=None, x__xgafv=None) + create(parent, body=None, sessionId=None, x__xgafv=None)
Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
 
 Args:
@@ -133,7 +133,7 @@ 

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -310,6 +310,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -390,6 +391,7 @@

Method Details

"userPseudoId": "A String", # A unique identifier for tracking users. } + sessionId: string, Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -416,7 +418,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -593,6 +595,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -725,7 +728,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -902,6 +905,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1022,7 +1026,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -1199,6 +1203,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1323,7 +1328,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -1500,6 +1505,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. @@ -1607,7 +1613,7 @@

Method Details

"A String", ], "answerText": "A String", # The textual answer. - "blobAttachments": [ # List of blob attachments in the answer. + "blobAttachments": [ # Output only. List of blob attachments in the answer. { # Stores binarydata attached to text answer, e.g. image, video, audio, etc. "attributionType": "A String", # Output only. The attribution type of the blob. "data": { # The media type and data of the blob. # Output only. The mime type and data of the blob. @@ -1784,6 +1790,7 @@

Method Details

"name": "A String", # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. "replies": [ # Replies of the assistant. { # One part of the multi-part response of the assist call. + "createTime": "A String", # The time when the reply was created. "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. "citationMetadata": { # A collection of source attributions for a piece of content. # Source attribution of the generated content. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check "citations": [ # Output only. List of citations. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html index 85df34b81c..3ea1b1c1cb 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html @@ -264,6 +264,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -463,6 +470,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -587,6 +601,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html index e4e7753ffd..c194bff6dd 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html @@ -209,6 +209,11 @@

Method Details

"mode": "A String", # Mode to use for documents that are crowded away. }, ], + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -249,6 +254,7 @@

Method Details

}, ], }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -291,7 +297,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -351,6 +357,13 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -534,6 +547,11 @@

Method Details

"mode": "A String", # Mode to use for documents that are crowded away. }, ], + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -574,6 +592,7 @@

Method Details

}, ], }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -616,7 +635,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -676,6 +695,13 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -835,6 +861,11 @@

Method Details

"mode": "A String", # Mode to use for documents that are crowded away. }, ], + "customRankingParams": { # Configuration parameters for the Custom Ranking feature. # Optional. Optional configuration for the Custom Ranking feature. + "expressionsToPrecompute": [ # Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field. + "A String", + ], + }, "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. For engines with a single data store, the specs directly under SearchRequest should be used. { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) @@ -875,6 +906,7 @@

Method Details

}, ], }, + "entity": "A String", # Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, "Google US", "Google Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity. "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. { # A facet specification to perform faceted search. "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. @@ -917,7 +949,7 @@

Method Details

], "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. "A String", ], }, @@ -977,6 +1009,13 @@

Method Details

"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. }, "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics and personalization. UserInfo.user_agent is used to deduce `device_type` for analytics. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html index cc4d76ffd2..2667780fbc 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.userEvents.html @@ -261,6 +261,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -417,6 +424,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. @@ -541,6 +555,13 @@

Method Details

"value": 3.14, # Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. }, "userInfo": { # Information of an end user. # Information about the end user. + "preciseLocation": { # Precise location info with multiple representation options. Currently only latitude and longitude point is supported. # Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents. + "address": "A String", # Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon. + "point": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. Location represented by a latitude/longitude point. + "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. + "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. + }, + }, "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.userStores.userLicenses.html b/docs/dyn/discoveryengine_v1beta.projects.locations.userStores.userLicenses.html index 3635512c02..56d7cfc1cc 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.userStores.userLicenses.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.userStores.userLicenses.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

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

Lists the User Licenses.

list_next()

@@ -90,11 +90,12 @@

Method Details

- list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the User Licenses.
 
 Args:
   parent: string, Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. (required)
+  filter: string, Optional. Filter for the list request. Supported fields: * `license_assignment_state` * `user_principal` * Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned. * `user_principal = user1@abc.com` to list user license for `user1@abc.com`.
   orderBy: string, Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. Redundant space characters in the syntax are insignificant. Supported fields (only `user_principal` is supported for now): * `user_principal` If not set, the default ordering is by `user_principal`. Examples: * `user_principal` to order by `user_principal` in ascending order. * `user_principal desc` to order by `user_principal` in descending order.
   pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned.
   pageToken: string, Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token.
diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json
index 1e41bc8221..4206c6f772 100644
--- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json
+++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json
@@ -13,6 +13,9 @@
 },
 "https://www.googleapis.com/auth/discoveryengine.readwrite": {
 "description": "View, edit, create, and delete all your data associated with any Discovery Engine API product, such as Agentspace, Vertex AI Search, or NotebookLM Enterprise, including both end user data and administration or configuration data."
+},
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite": {
+"description": "Interact with Discovery Engine API products, such as Agentspace, Vertex AI Search, or NotebookLM Enterprise, on your behalf. It will also allow the app to view all data that you have access to when you use or interact with a Discovery Engine API product."
 }
 }
 }
@@ -141,6 +144,74 @@
 },
 "protocol": "rest",
 "resources": {
+"billingAccounts": {
+"resources": {
+"billingAccountLicenseConfigs": {
+"methods": {
+"distributeLicenseConfig": {
+"description": "Distributes a LicenseConfig from billing account level to project level.",
+"flatPath": "v1/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}:distributeLicenseConfig",
+"httpMethod": "POST",
+"id": "discoveryengine.billingAccounts.billingAccountLicenseConfigs.distributeLicenseConfig",
+"parameterOrder": [
+"billingAccountLicenseConfig"
+],
+"parameters": {
+"billingAccountLicenseConfig": {
+"description": "Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.",
+"location": "path",
+"pattern": "^billingAccounts/[^/]+/billingAccountLicenseConfigs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+billingAccountLicenseConfig}:distributeLicenseConfig",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1DistributeLicenseConfigRequest"
+},
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1DistributeLicenseConfigResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
+]
+},
+"retractLicenseConfig": {
+"description": "This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.",
+"flatPath": "v1/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}:retractLicenseConfig",
+"httpMethod": "POST",
+"id": "discoveryengine.billingAccounts.billingAccountLicenseConfigs.retractLicenseConfig",
+"parameterOrder": [
+"billingAccountLicenseConfig"
+],
+"parameters": {
+"billingAccountLicenseConfig": {
+"description": "Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.",
+"location": "path",
+"pattern": "^billingAccounts/[^/]+/billingAccountLicenseConfigs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+billingAccountLicenseConfig}:retractLicenseConfig",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1RetractLicenseConfigRequest"
+},
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1RetractLicenseConfigResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
+]
+}
+}
+}
+}
+},
 "projects": {
 "methods": {
 "provision": {
@@ -169,7 +240,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -199,7 +271,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getCmekConfig": {
@@ -225,7 +298,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "setUpDataConnector": {
@@ -255,7 +329,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "setUpDataConnectorV2": {
@@ -295,7 +370,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "updateAclConfig": {
@@ -324,7 +400,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "updateCmekConfig": {
@@ -358,7 +435,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -388,7 +466,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -414,7 +493,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -440,7 +520,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -474,7 +555,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -504,7 +586,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getDataConnector": {
@@ -531,7 +614,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "updateDataConnector": {
@@ -567,12 +651,73 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
 "resources": {
 "dataConnector": {
+"methods": {
+"mcp": {
+"description": "ServeMcpDeleteRequest serves a MCP DELETE request.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/mcp",
+"httpMethod": "DELETE",
+"id": "discoveryengine.projects.locations.collections.dataConnector.mcp",
+"parameterOrder": [
+"projectsId",
+"locationsId",
+"collectionsId"
+],
+"parameters": {
+"collectionsId": {
+"location": "path",
+"required": true,
+"type": "string"
+},
+"contentType": {
+"description": "The HTTP Content-Type header value specifying the content type of the body.",
+"location": "query",
+"type": "string"
+},
+"data": {
+"description": "The HTTP request/response body as raw binary.",
+"format": "byte",
+"location": "query",
+"type": "string"
+},
+"extensions": {
+"additionalProperties": {
+"description": "Properties of the object. Contains field @type with type URL.",
+"type": "any"
+},
+"description": "Application specific response metadata. Must be set in the first response for streaming APIs.",
+"location": "query",
+"repeated": true,
+"type": "object"
+},
+"locationsId": {
+"location": "path",
+"required": true,
+"type": "string"
+},
+"projectsId": {
+"location": "path",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/mcp",
+"response": {
+"$ref": "GoogleApiHttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
+]
+}
+},
 "resources": {
 "operations": {
 "methods": {
@@ -599,7 +744,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -646,7 +792,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -699,7 +846,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -753,7 +901,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -779,7 +928,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -805,7 +955,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getSiteSearchEngine": {
@@ -831,7 +982,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -873,7 +1025,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -908,7 +1061,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "trainCustomModel": {
@@ -937,7 +1091,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -979,7 +1134,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -1017,7 +1173,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -1043,7 +1200,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -1069,7 +1227,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "import": {
@@ -1098,7 +1257,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -1135,7 +1295,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -1175,7 +1336,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -1204,7 +1366,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1237,7 +1400,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -1263,7 +1427,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -1310,7 +1475,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1347,7 +1513,8 @@
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/cloud_search.query",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1381,7 +1548,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -1411,7 +1579,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1449,7 +1618,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -1475,7 +1645,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -1501,7 +1672,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -1543,7 +1715,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -1578,7 +1751,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1611,7 +1785,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -1640,7 +1815,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -1666,7 +1842,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -1692,7 +1869,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -1739,7 +1917,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -1774,7 +1953,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1804,7 +1984,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1836,7 +2017,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -1883,7 +2065,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1915,7 +2098,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -1962,7 +2146,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -2000,7 +2185,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -2026,7 +2212,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -2052,7 +2239,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -2089,7 +2277,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -2123,7 +2312,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -2153,7 +2343,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -2200,7 +2391,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -2219,7 +2411,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
+"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -2235,7 +2427,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -2269,7 +2462,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -2295,7 +2489,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -2321,7 +2516,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -2358,7 +2554,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -2393,7 +2590,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "recommend": {
@@ -2422,7 +2620,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "search": {
@@ -2452,7 +2651,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "searchLite": {
@@ -2482,7 +2682,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "streamAnswer": {
@@ -2495,7 +2696,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
+"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -2511,7 +2712,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -2533,6 +2735,11 @@
 "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
 "required": true,
 "type": "string"
+},
+"sessionId": {
+"description": "Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated.",
+"location": "query",
+"type": "string"
 }
 },
 "path": "v1/{+parent}/sessions",
@@ -2545,7 +2752,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -2572,7 +2780,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -2604,7 +2813,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -2652,7 +2862,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -2688,7 +2899,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -2718,7 +2930,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -2753,7 +2966,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "disableAdvancedSiteSearch": {
@@ -2782,7 +2996,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "enableAdvancedSiteSearch": {
@@ -2811,7 +3026,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "fetchDomainVerificationStatus": {
@@ -2848,7 +3064,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "recrawlUris": {
@@ -2877,7 +3094,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -2907,7 +3125,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -2954,7 +3173,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -2987,7 +3207,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -3013,7 +3234,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "fetch": {
@@ -3045,7 +3267,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -3078,7 +3301,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -3107,7 +3331,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -3133,7 +3358,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -3159,7 +3385,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -3196,7 +3423,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -3225,7 +3453,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -3255,7 +3484,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -3302,7 +3532,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -3340,7 +3571,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -3370,7 +3602,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -3417,7 +3650,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "import": {
@@ -3447,7 +3681,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -3477,7 +3712,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "write": {
@@ -3512,7 +3748,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -3553,7 +3790,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -3589,7 +3827,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -3629,7 +3868,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -3655,7 +3895,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -3681,7 +3922,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getIamPolicy": {
@@ -3713,7 +3955,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -3755,7 +3998,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -3790,7 +4034,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "setIamPolicy": {
@@ -3819,7 +4064,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -3858,7 +4104,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -3885,7 +4132,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -3912,7 +4160,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -3950,7 +4199,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -3986,7 +4236,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "streamAssist": {
@@ -4016,7 +4267,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -4049,7 +4301,9 @@
 "$ref": "A2aV1AgentCard"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -4081,7 +4335,9 @@
 "$ref": "A2aV1SendMessageResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "stream": {
@@ -4109,7 +4365,9 @@
 "$ref": "A2aV1StreamResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -4149,7 +4407,9 @@
 "$ref": "A2aV1Task"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -4188,7 +4448,9 @@
 "$ref": "A2aV1Task"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "subscribe": {
@@ -4221,7 +4483,9 @@
 "$ref": "A2aV1StreamResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -4266,7 +4530,9 @@
 "$ref": "A2aV1TaskPushNotificationConfig"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -4299,7 +4565,9 @@
 "$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -4332,7 +4600,9 @@
 "$ref": "A2aV1TaskPushNotificationConfig"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -4376,7 +4646,9 @@
 "$ref": "A2aV1ListTaskPushNotificationConfigResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -4412,7 +4684,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -4451,7 +4724,8 @@
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/cloud_search.query",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -4489,7 +4763,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -4515,7 +4790,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -4541,7 +4817,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -4583,7 +4860,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -4618,7 +4896,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -4651,7 +4930,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -4680,7 +4960,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -4706,7 +4987,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -4732,7 +5014,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -4779,7 +5062,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -4814,7 +5098,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -4847,7 +5132,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -4873,7 +5159,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -4920,7 +5207,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -4937,7 +5225,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
+"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -4953,7 +5241,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -4987,7 +5276,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -5013,7 +5303,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -5039,7 +5330,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -5076,7 +5368,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -5111,7 +5404,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "recommend": {
@@ -5140,7 +5434,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "search": {
@@ -5170,7 +5465,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "searchLite": {
@@ -5200,7 +5496,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "streamAnswer": {
@@ -5213,7 +5510,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
+"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -5229,7 +5526,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -5251,6 +5549,11 @@
 "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
 "required": true,
 "type": "string"
+},
+"sessionId": {
+"description": "Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated.",
+"location": "query",
+"type": "string"
 }
 },
 "path": "v1/{+parent}/sessions",
@@ -5263,7 +5566,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -5290,7 +5594,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -5322,7 +5627,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -5370,7 +5676,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -5406,7 +5713,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -5436,7 +5744,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -5479,7 +5788,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -5515,7 +5825,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -5547,7 +5858,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -5594,7 +5906,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -5647,7 +5960,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -5701,7 +6015,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -5727,7 +6042,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -5753,7 +6069,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getSiteSearchEngine": {
@@ -5779,7 +6096,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -5821,7 +6139,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -5856,7 +6175,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -5898,7 +6218,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -5936,7 +6257,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -5962,7 +6284,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -5988,7 +6311,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "import": {
@@ -6017,7 +6341,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -6054,7 +6379,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -6094,7 +6420,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -6123,7 +6450,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -6156,7 +6484,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -6182,7 +6511,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -6229,7 +6559,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -6266,7 +6597,8 @@
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/cloud_search.query",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -6300,7 +6632,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -6330,7 +6663,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -6368,7 +6702,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -6394,7 +6729,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -6420,7 +6756,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -6462,7 +6799,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -6497,7 +6835,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -6530,7 +6869,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -6559,7 +6899,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -6585,7 +6926,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -6611,7 +6953,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -6658,7 +7001,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -6693,7 +7037,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -6725,7 +7070,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -6772,7 +7118,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -6804,7 +7151,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -6851,7 +7199,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -6889,7 +7238,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -6915,7 +7265,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -6941,7 +7292,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -6978,7 +7330,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -7012,7 +7365,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -7029,7 +7383,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
+"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -7045,7 +7399,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -7079,7 +7434,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -7105,7 +7461,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -7131,7 +7488,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -7168,7 +7526,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -7203,7 +7562,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "recommend": {
@@ -7232,7 +7592,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "search": {
@@ -7262,7 +7623,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "searchLite": {
@@ -7292,7 +7654,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "streamAnswer": {
@@ -7305,7 +7668,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
+"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -7321,7 +7684,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -7343,6 +7707,11 @@
 "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
 "required": true,
 "type": "string"
+},
+"sessionId": {
+"description": "Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated.",
+"location": "query",
+"type": "string"
 }
 },
 "path": "v1/{+parent}/sessions",
@@ -7355,7 +7724,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -7382,7 +7752,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -7414,7 +7785,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -7462,7 +7834,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -7498,7 +7871,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -7528,7 +7902,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -7563,7 +7938,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "enableAdvancedSiteSearch": {
@@ -7592,7 +7968,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "recrawlUris": {
@@ -7621,7 +7998,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -7654,7 +8032,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -7680,7 +8059,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "fetch": {
@@ -7712,7 +8092,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -7745,7 +8126,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -7774,7 +8156,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -7800,7 +8183,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -7826,7 +8210,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -7863,7 +8248,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -7892,7 +8278,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -7928,7 +8315,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -7958,7 +8346,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8005,7 +8394,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "import": {
@@ -8035,7 +8425,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -8065,7 +8456,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "write": {
@@ -8100,7 +8492,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8141,7 +8534,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -8177,7 +8571,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8212,7 +8607,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8260,7 +8656,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -8286,7 +8683,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -8312,7 +8710,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "importIdentityMappings": {
@@ -8341,7 +8740,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -8378,7 +8778,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "listIdentityMappings": {
@@ -8415,7 +8816,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purgeIdentityMappings": {
@@ -8444,7 +8846,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -8474,7 +8877,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -8521,7 +8925,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8561,7 +8966,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -8587,7 +8993,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -8622,7 +9029,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8652,7 +9060,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -8699,7 +9108,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8731,7 +9141,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8766,7 +9177,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8813,7 +9225,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "import": {
@@ -8843,7 +9256,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "write": {
@@ -8878,7 +9292,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8911,7 +9326,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -8937,7 +9353,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -8972,7 +9389,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -9002,7 +9420,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -9018,6 +9437,11 @@
 "parent"
 ],
 "parameters": {
+"filter": {
+"description": "Optional. Filter for the list request. Supported fields: * `license_assignment_state` * `user_principal` * Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned. * `user_principal = user1@abc.com` to list user license for `user1@abc.com`.",
+"location": "query",
+"type": "string"
+},
 "orderBy": {
 "description": "Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a \" desc\" suffix. Redundant space characters in the syntax are insignificant. Supported fields (only `user_principal` is supported for now): * `user_principal` If not set, the default ordering is by `user_principal`. Examples: * `user_principal` to order by `user_principal` in ascending order. * `user_principal desc` to order by `user_principal` in descending order.",
 "location": "query",
@@ -9048,7 +9472,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -9085,7 +9510,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -9111,7 +9537,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -9158,7 +9585,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -9166,7 +9594,7 @@
 }
 }
 },
-"revision": "20260322",
+"revision": "20260413",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "A2aV1APIKeySecurityScheme": {
@@ -10561,6 +10989,10 @@
 "description": "Optional. Action parameters in structured json format.",
 "type": "object"
 },
+"createBapConnection": {
+"description": "Optional. Whether to create a BAP connection for the connector.",
+"type": "boolean"
+},
 "isActionConfigured": {
 "description": "Output only. The connector contains the necessary parameters and is configured to support actions.",
 "readOnly": true,
@@ -12356,6 +12788,11 @@
 "description": "One part of the multi-part response of the assist call.",
 "id": "GoogleCloudDiscoveryengineV1AssistAnswerReply",
 "properties": {
+"createTime": {
+"description": "The time when the reply was created.",
+"format": "google-datetime",
+"type": "string"
+},
 "groundedContent": {
 "$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContent",
 "description": "Possibly grounded response text or media from the assistant."
@@ -12382,6 +12819,12 @@
 "description": "Discovery Engine Assistant resource.",
 "id": "GoogleCloudDiscoveryengineV1Assistant",
 "properties": {
+"createTime": {
+"description": "Output only. Represents the time when this Assistant was created.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
 "customerPolicy": {
 "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicy",
 "description": "Optional. Customer policy for the assistant."
@@ -12413,6 +12856,12 @@
 "description": "Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.",
 "type": "string"
 },
+"updateTime": {
+"description": "Output only. Represents the time when this Assistant was most recently updated.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
 "webGroundingType": {
 "description": "Optional. The type of web grounding to use.",
 "enum": [
@@ -13574,6 +14023,20 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1CliConfig": {
+"description": "The configuration for the CLI execution based connectors.",
+"id": "GoogleCloudDiscoveryengineV1CliConfig",
+"properties": {
+"enabledActions": {
+"description": "Optional. The actions enabled on the associated CLI connection.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1CloudSqlSource": {
 "description": "Cloud SQL source import data from.",
 "id": "GoogleCloudDiscoveryengineV1CloudSqlSource",
@@ -14504,6 +14967,10 @@
 "readOnly": true,
 "type": "array"
 },
+"cliConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1CliConfig",
+"description": "Optional. The configuration for establishing a CLI connection."
+},
 "connectorModes": {
 "description": "Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.",
 "items": {
@@ -15482,6 +15949,42 @@
 "properties": {},
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1DistributeLicenseConfigRequest": {
+"description": "Request message for LicenseConfigService.DistributeLicenseConfig method.",
+"id": "GoogleCloudDiscoveryengineV1DistributeLicenseConfigRequest",
+"properties": {
+"licenseConfigId": {
+"description": "Optional. Distribute seats to this license config instead of creating a new one. If not specified, a new license config will be created from the billing account license config.",
+"type": "string"
+},
+"licenseCount": {
+"description": "Required. The number of licenses to distribute.",
+"format": "int64",
+"type": "string"
+},
+"location": {
+"description": "Required. The target GCP project region to distribute the license config to.",
+"type": "string"
+},
+"projectNumber": {
+"description": "Required. The target GCP project number to distribute the license config to.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DistributeLicenseConfigResponse": {
+"description": "Response message for LicenseConfigService.DistributeLicenseConfig method.",
+"id": "GoogleCloudDiscoveryengineV1DistributeLicenseConfigResponse",
+"properties": {
+"licenseConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1LicenseConfig",
+"description": "The updated or created LicenseConfig."
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1Document": {
 "description": "Document captures all raw metadata information of items to be recommended or searched.",
 "id": "GoogleCloudDiscoveryengineV1Document",
@@ -15968,7 +16471,7 @@
 ],
 "type": "string"
 },
-"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails`",
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`",
 "type": "object"
 },
 "industryVertical": {
@@ -18359,6 +18862,37 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1RetractLicenseConfigRequest": {
+"description": "Request message for LicenseConfigService.RetractLicenseConfig method.",
+"id": "GoogleCloudDiscoveryengineV1RetractLicenseConfigRequest",
+"properties": {
+"fullRetract": {
+"description": "Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count.",
+"type": "boolean"
+},
+"licenseConfig": {
+"description": "Required. Full resource name of LicenseConfig. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config_id}`.",
+"type": "string"
+},
+"licenseCount": {
+"description": "Optional. The number of licenses to retract. Only used when full_retract is false.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1RetractLicenseConfigResponse": {
+"description": "Response message for LicenseConfigService.RetractLicenseConfig method.",
+"id": "GoogleCloudDiscoveryengineV1RetractLicenseConfigResponse",
+"properties": {
+"licenseConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1LicenseConfig",
+"description": "The updated LicenseConfig."
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1SafetyRating": {
 "description": "Safety rating corresponding to the generated content.",
 "id": "GoogleCloudDiscoveryengineV1SafetyRating",
@@ -18543,6 +19077,10 @@
 },
 "type": "array"
 },
+"customRankingParams": {
+"$ref": "GoogleCloudDiscoveryengineV1SearchRequestCustomRankingParams",
+"description": "Optional. Optional configuration for the Custom Ranking feature."
+},
 "dataStoreSpecs": {
 "description": "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. For engines with a single data store, the specs directly under SearchRequest should be used.",
 "items": {
@@ -18554,6 +19092,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec",
 "description": "Optional. Config for display feature, like match highlighting on search results."
 },
+"entity": {
+"description": "Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, \"Google US\", \"Google Ads\", \"Waymo\", \"google.com\", \"youtube.com\", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity.",
+"type": "string"
+},
 "facetSpecs": {
 "description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "items": {
@@ -19017,6 +19559,20 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1SearchRequestCustomRankingParams": {
+"description": "Configuration parameters for the Custom Ranking feature.",
+"id": "GoogleCloudDiscoveryengineV1SearchRequestCustomRankingParams",
+"properties": {
+"expressionsToPrecompute": {
+"description": "Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec": {
 "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "id": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec",
@@ -19191,7 +19747,7 @@ false
 "type": "string"
 },
 "geoSearchQueryDetectionFieldNames": {
-"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.",
+"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`.",
 "items": {
 "type": "string"
 },
@@ -19686,6 +20242,14 @@ false
 "format": "float",
 "type": "number"
 },
+"precomputedExpressionValues": {
+"description": "Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`.",
+"items": {
+"format": "float",
+"type": "number"
+},
+"type": "array"
+},
 "relevanceScore": {
 "description": "Optional. Semantic relevance adjustment.",
 "format": "float",
@@ -20916,6 +21480,10 @@ false
 "description": "Information of an end user.",
 "id": "GoogleCloudDiscoveryengineV1UserInfo",
 "properties": {
+"preciseLocation": {
+"$ref": "GoogleCloudDiscoveryengineV1UserInfoPreciseLocation",
+"description": "Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents."
+},
 "timeZone": {
 "description": "Optional. IANA time zone, e.g. Europe/Budapest.",
 "type": "string"
@@ -20931,6 +21499,21 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1UserInfoPreciseLocation": {
+"description": "Precise location info with multiple representation options. Currently only latitude and longitude point is supported.",
+"id": "GoogleCloudDiscoveryengineV1UserInfoPreciseLocation",
+"properties": {
+"address": {
+"description": "Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.",
+"type": "string"
+},
+"point": {
+"$ref": "GoogleTypeLatLng",
+"description": "Optional. Location represented by a latitude/longitude point."
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1UserLicense": {
 "description": "User License information assigned by the admin.",
 "id": "GoogleCloudDiscoveryengineV1UserLicense",
@@ -21691,7 +22274,7 @@ false
 ],
 "type": "string"
 },
-"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails`",
+"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`",
 "readOnly": true,
 "type": "object"
 },
@@ -21883,6 +22466,10 @@ false
 "description": "Optional. Action parameters in structured json format.",
 "type": "object"
 },
+"createBapConnection": {
+"description": "Optional. Whether to create a BAP connection for the connector.",
+"type": "boolean"
+},
 "isActionConfigured": {
 "description": "Output only. The connector contains the necessary parameters and is configured to support actions.",
 "readOnly": true,
@@ -22131,10 +22718,11 @@ false
 "type": "string"
 },
 "blobAttachments": {
-"description": "List of blob attachments in the answer.",
+"description": "Output only. List of blob attachments in the answer.",
 "items": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment"
 },
+"readOnly": true,
 "type": "array"
 },
 "citations": {
@@ -22844,6 +23432,11 @@ false
 "description": "One part of the multi-part response of the assist call.",
 "id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerReply",
 "properties": {
+"createTime": {
+"description": "The time when the reply was created.",
+"format": "google-datetime",
+"type": "string"
+},
 "groundedContent": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent",
 "description": "Possibly grounded response text or media from the assistant."
@@ -23246,6 +23839,20 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaCliConfig": {
+"description": "The configuration for the CLI execution based connectors.",
+"id": "GoogleCloudDiscoveryengineV1alphaCliConfig",
+"properties": {
+"enabledActions": {
+"description": "Optional. The actions enabled on the associated CLI connection.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaCmekConfig": {
 "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.",
 "id": "GoogleCloudDiscoveryengineV1alphaCmekConfig",
@@ -24065,6 +24672,10 @@ false
 "readOnly": true,
 "type": "array"
 },
+"cliConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaCliConfig",
+"description": "Optional. The configuration for establishing a CLI connection."
+},
 "connectorModes": {
 "description": "Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.",
 "items": {
@@ -24596,6 +25207,10 @@ false
 "readOnly": true,
 "type": "string"
 },
+"dataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy",
+"description": "Optional. Specifies the data protection policy for the data store."
+},
 "defaultSchemaId": {
 "description": "Output only. The id of the default Schema associated to this data store.",
 "readOnly": true,
@@ -25437,7 +26052,7 @@ false
 ],
 "type": "string"
 },
-"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails`",
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`",
 "type": "object"
 },
 "industryVertical": {
@@ -27913,6 +28528,10 @@ false
 "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec",
 "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec."
 },
+"customRankingParams": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams",
+"description": "Optional. Optional configuration for the Custom Ranking feature."
+},
 "dataStoreSpecs": {
 "description": "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. For engines with a single data store, the specs directly under SearchRequest should be used.",
 "items": {
@@ -27928,6 +28547,10 @@ false
 "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec",
 "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path."
 },
+"entity": {
+"description": "Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, \"Google US\", \"Google Ads\", \"Waymo\", \"google.com\", \"youtube.com\", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity.",
+"type": "string"
+},
 "facetSpecs": {
 "description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "items": {
@@ -28442,6 +29065,20 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams": {
+"description": "Configuration parameters for the Custom Ranking feature.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams",
+"properties": {
+"expressionsToPrecompute": {
+"description": "Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": {
 "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec",
@@ -28649,7 +29286,7 @@ false
 "type": "string"
 },
 "geoSearchQueryDetectionFieldNames": {
-"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.",
+"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`.",
 "items": {
 "type": "string"
 },
@@ -29346,6 +29983,10 @@ false
 "description": "Information of an end user.",
 "id": "GoogleCloudDiscoveryengineV1alphaUserInfo",
 "properties": {
+"preciseLocation": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation",
+"description": "Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents."
+},
 "timeZone": {
 "description": "Optional. IANA time zone, e.g. Europe/Budapest.",
 "type": "string"
@@ -29361,6 +30002,21 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation": {
+"description": "Precise location info with multiple representation options. Currently only latitude and longitude point is supported.",
+"id": "GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation",
+"properties": {
+"address": {
+"description": "Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.",
+"type": "string"
+},
+"point": {
+"$ref": "GoogleTypeLatLng",
+"description": "Optional. Location represented by a latitude/longitude point."
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaUserLicense": {
 "description": "User License information assigned by the admin.",
 "id": "GoogleCloudDiscoveryengineV1alphaUserLicense",
@@ -30813,7 +31469,7 @@ false
 ],
 "type": "string"
 },
-"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails`",
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`",
 "type": "object"
 },
 "industryVertical": {
@@ -32367,6 +33023,10 @@ false
 },
 "type": "array"
 },
+"customRankingParams": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams",
+"description": "Optional. Optional configuration for the Custom Ranking feature."
+},
 "dataStoreSpecs": {
 "description": "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. For engines with a single data store, the specs directly under SearchRequest should be used.",
 "items": {
@@ -32382,6 +33042,10 @@ false
 "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec",
 "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path."
 },
+"entity": {
+"description": "Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, \"Google US\", \"Google Ads\", \"Waymo\", \"google.com\", \"youtube.com\", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity.",
+"type": "string"
+},
 "facetSpecs": {
 "description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "items": {
@@ -32892,6 +33556,20 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams": {
+"description": "Configuration parameters for the Custom Ranking feature.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams",
+"properties": {
+"expressionsToPrecompute": {
+"description": "Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": {
 "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec",
@@ -33099,7 +33777,7 @@ false
 "type": "string"
 },
 "geoSearchQueryDetectionFieldNames": {
-"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.",
+"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`.",
 "items": {
 "type": "string"
 },
@@ -33605,6 +34283,10 @@ false
 "description": "Information of an end user.",
 "id": "GoogleCloudDiscoveryengineV1betaUserInfo",
 "properties": {
+"preciseLocation": {
+"$ref": "GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation",
+"description": "Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents."
+},
 "timeZone": {
 "description": "Optional. IANA time zone, e.g. Europe/Budapest.",
 "type": "string"
@@ -33620,6 +34302,21 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation": {
+"description": "Precise location info with multiple representation options. Currently only latitude and longitude point is supported.",
+"id": "GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation",
+"properties": {
+"address": {
+"description": "Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.",
+"type": "string"
+},
+"point": {
+"$ref": "GoogleTypeLatLng",
+"description": "Optional. Location represented by a latitude/longitude point."
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaUserLicense": {
 "description": "User License information assigned by the admin.",
 "id": "GoogleCloudDiscoveryengineV1betaUserLicense",
@@ -34135,6 +34832,23 @@ false
 },
 "type": "object"
 },
+"GoogleTypeLatLng": {
+"description": "An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.",
+"id": "GoogleTypeLatLng",
+"properties": {
+"latitude": {
+"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+"format": "double",
+"type": "number"
+},
+"longitude": {
+"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+"format": "double",
+"type": "number"
+}
+},
+"type": "object"
+},
 "GoogleTypeTimeZone": {
 "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).",
 "id": "GoogleTypeTimeZone",
diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json
index 3471224f42..152e9e9102 100644
--- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json
@@ -13,6 +13,9 @@
 },
 "https://www.googleapis.com/auth/discoveryengine.readwrite": {
 "description": "View, edit, create, and delete all your data associated with any Discovery Engine API product, such as Agentspace, Vertex AI Search, or NotebookLM Enterprise, including both end user data and administration or configuration data."
+},
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite": {
+"description": "Interact with Discovery Engine API products, such as Agentspace, Vertex AI Search, or NotebookLM Enterprise, on your behalf. It will also allow the app to view all data that you have access to when you use or interact with a Discovery Engine API product."
 }
 }
 }
@@ -171,7 +174,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -197,7 +201,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -234,7 +239,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "retractLicenseConfig": {
@@ -263,7 +269,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -295,7 +302,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -330,7 +338,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "provision": {
@@ -359,7 +368,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "reportConsentChange": {
@@ -388,7 +398,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -450,7 +461,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "estimateDataSize": {
@@ -479,7 +491,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getAclConfig": {
@@ -505,7 +518,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getCmekConfig": {
@@ -531,7 +545,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "obtainCrawlRate": {
@@ -560,7 +575,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "queryConfigurablePricingUsageStats": {
@@ -651,7 +667,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "removeDedicatedCrawlRate": {
@@ -680,7 +697,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "setDedicatedCrawlRate": {
@@ -709,7 +727,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "setUpDataConnector": {
@@ -739,7 +758,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "setUpDataConnectorV2": {
@@ -779,7 +799,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "updateAclConfig": {
@@ -808,7 +829,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "updateCmekConfig": {
@@ -842,7 +864,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -880,7 +903,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -906,7 +930,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -932,7 +957,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -969,7 +995,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -1004,7 +1031,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1034,7 +1062,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -1060,7 +1089,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -1086,7 +1116,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -1120,7 +1151,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1150,7 +1182,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -1176,7 +1209,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getDataConnector": {
@@ -1203,7 +1237,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -1245,7 +1280,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -1280,7 +1316,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "updateDataConnector": {
@@ -1316,7 +1353,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -1350,7 +1388,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "checkRefreshToken": {
@@ -1378,7 +1417,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getConnectorSecret": {
@@ -1405,7 +1445,66 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
+]
+},
+"mcp": {
+"description": "ServeMcpDeleteRequest serves a MCP DELETE request.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/mcp",
+"httpMethod": "DELETE",
+"id": "discoveryengine.projects.locations.collections.dataConnector.mcp",
+"parameterOrder": [
+"projectsId",
+"locationsId",
+"collectionsId"
+],
+"parameters": {
+"collectionsId": {
+"location": "path",
+"required": true,
+"type": "string"
+},
+"contentType": {
+"description": "The HTTP Content-Type header value specifying the content type of the body.",
+"location": "query",
+"type": "string"
+},
+"data": {
+"description": "The HTTP request/response body as raw binary.",
+"format": "byte",
+"location": "query",
+"type": "string"
+},
+"extensions": {
+"additionalProperties": {
+"description": "Properties of the object. Contains field @type with type URL.",
+"type": "any"
+},
+"description": "Application specific response metadata. Must be set in the first response for streaming APIs.",
+"location": "query",
+"repeated": true,
+"type": "object"
+},
+"locationsId": {
+"location": "path",
+"required": true,
+"type": "string"
+},
+"projectsId": {
+"location": "path",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector/mcp",
+"response": {
+"$ref": "GoogleApiHttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "startConnectorRun": {
@@ -1435,7 +1534,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -1477,7 +1577,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1507,7 +1608,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -1554,7 +1656,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1589,7 +1692,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "completeQuery": {
@@ -1636,7 +1740,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -1691,7 +1796,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -1718,7 +1824,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "deletePatientFilter": {
@@ -1747,7 +1854,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -1774,7 +1882,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getDocumentProcessingConfig": {
@@ -1800,7 +1909,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getSiteSearchEngine": {
@@ -1826,7 +1936,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -1868,7 +1979,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -1903,7 +2015,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "removePatientFilter": {
@@ -1932,7 +2045,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "replacePatientFilter": {
@@ -1961,7 +2075,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "trainCustomModel": {
@@ -1990,7 +2105,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "updateDocumentProcessingConfig": {
@@ -2025,7 +2141,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -2067,7 +2184,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -2108,7 +2226,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -2149,7 +2268,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -2187,7 +2307,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -2213,7 +2334,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -2239,7 +2361,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getProcessedDocument": {
@@ -2302,7 +2425,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "import": {
@@ -2331,7 +2455,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -2368,7 +2493,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -2408,7 +2534,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -2437,7 +2564,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -2467,7 +2595,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -2504,7 +2633,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -2539,7 +2669,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -2565,7 +2696,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -2612,7 +2744,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -2649,7 +2782,8 @@
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/cloud_search.query",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -2683,7 +2817,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -2713,7 +2848,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -2751,7 +2887,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -2777,7 +2914,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -2803,7 +2941,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -2845,7 +2984,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -2880,7 +3020,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -2913,7 +3054,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -2942,7 +3084,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -2968,7 +3111,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -2994,7 +3138,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -3041,7 +3186,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -3076,7 +3222,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -3106,7 +3253,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -3138,7 +3286,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -3185,7 +3334,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -3217,7 +3367,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -3264,7 +3415,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -3302,7 +3454,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -3328,7 +3481,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -3354,7 +3508,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -3391,7 +3546,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -3425,7 +3581,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -3455,7 +3612,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -3502,7 +3660,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -3521,7 +3680,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
+"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -3538,7 +3697,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -3572,7 +3732,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -3598,7 +3759,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -3624,7 +3786,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -3661,7 +3824,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -3696,7 +3860,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "recommend": {
@@ -3725,7 +3890,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "search": {
@@ -3755,7 +3921,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "searchLite": {
@@ -3785,7 +3952,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "streamAnswer": {
@@ -3798,7 +3966,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
+"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -3815,7 +3983,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -3837,6 +4006,11 @@
 "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
 "required": true,
 "type": "string"
+},
+"sessionId": {
+"description": "Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated.",
+"location": "query",
+"type": "string"
 }
 },
 "path": "v1alpha/{+parent}/sessions",
@@ -3849,7 +4023,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -3876,7 +4051,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -3908,7 +4084,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -3956,7 +4133,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -3992,7 +4170,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -4022,7 +4201,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -4057,7 +4237,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "disableAdvancedSiteSearch": {
@@ -4086,7 +4267,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "enableAdvancedSiteSearch": {
@@ -4115,7 +4297,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "fetchDomainVerificationStatus": {
@@ -4152,7 +4335,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getUriPatternDocumentData": {
@@ -4178,7 +4362,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "recrawlUris": {
@@ -4207,7 +4392,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "setUriPatternDocumentData": {
@@ -4236,7 +4422,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -4266,7 +4453,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -4313,7 +4501,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -4346,7 +4535,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -4372,7 +4562,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "fetch": {
@@ -4404,7 +4595,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -4437,7 +4629,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -4466,7 +4659,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -4492,7 +4686,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -4518,7 +4713,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -4555,7 +4751,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -4584,7 +4781,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -4614,7 +4812,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -4661,7 +4860,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -4699,7 +4899,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -4729,7 +4930,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -4776,7 +4978,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "import": {
@@ -4806,7 +5009,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -4836,7 +5040,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "write": {
@@ -4871,7 +5076,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -4912,7 +5118,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -4948,7 +5155,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -4988,7 +5196,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -5014,7 +5223,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -5040,7 +5250,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getIamPolicy": {
@@ -5072,7 +5283,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getWorkspaceSettings": {
@@ -5098,7 +5310,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -5140,7 +5353,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -5175,7 +5389,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "pause": {
@@ -5204,7 +5419,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "resume": {
@@ -5233,7 +5449,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "setIamPolicy": {
@@ -5262,7 +5479,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "tune": {
@@ -5291,7 +5509,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -5324,7 +5543,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getConfig": {
@@ -5350,7 +5570,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "updateConfig": {
@@ -5385,7 +5606,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -5424,7 +5646,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -5451,7 +5674,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -5478,7 +5702,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -5516,7 +5741,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -5552,7 +5778,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "streamAssist": {
@@ -5582,7 +5809,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -5616,7 +5844,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -5643,7 +5872,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -5670,7 +5900,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -5718,7 +5949,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -5754,7 +5986,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -5788,7 +6021,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -5818,7 +6052,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -5859,7 +6094,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -5886,7 +6122,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -5913,7 +6150,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -5956,7 +6194,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -5992,7 +6231,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -6029,7 +6269,8 @@
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/cloud_search.query",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "removeSuggestion": {
@@ -6059,7 +6300,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -6097,7 +6339,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -6123,7 +6366,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -6149,7 +6393,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -6191,7 +6436,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -6226,7 +6472,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -6259,7 +6506,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -6288,7 +6536,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -6314,7 +6563,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -6340,7 +6590,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -6387,7 +6638,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -6422,7 +6674,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -6452,7 +6705,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -6499,7 +6753,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -6516,7 +6771,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
+"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -6533,7 +6788,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -6567,7 +6823,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -6593,7 +6850,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -6619,7 +6877,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -6656,7 +6915,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -6691,7 +6951,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "recommend": {
@@ -6720,7 +6981,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "search": {
@@ -6750,7 +7012,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "searchLite": {
@@ -6780,7 +7043,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "streamAnswer": {
@@ -6793,7 +7057,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
+"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -6810,7 +7074,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -6832,6 +7097,11 @@
 "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
 "required": true,
 "type": "string"
+},
+"sessionId": {
+"description": "Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated.",
+"location": "query",
+"type": "string"
 }
 },
 "path": "v1alpha/{+parent}/sessions",
@@ -6844,7 +7114,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -6871,7 +7142,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -6903,7 +7175,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -6951,7 +7224,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -6987,7 +7261,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -7019,7 +7294,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -7051,7 +7327,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -7103,7 +7380,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -7133,7 +7411,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -7176,7 +7455,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -7212,7 +7492,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -7244,7 +7525,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -7291,7 +7573,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -7326,7 +7609,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "completeQuery": {
@@ -7373,7 +7657,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -7428,7 +7713,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -7455,7 +7741,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "deletePatientFilter": {
@@ -7484,7 +7771,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -7511,7 +7799,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getDocumentProcessingConfig": {
@@ -7537,7 +7826,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getSiteSearchEngine": {
@@ -7563,7 +7853,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -7605,7 +7896,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -7640,7 +7932,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "removePatientFilter": {
@@ -7669,7 +7962,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "replacePatientFilter": {
@@ -7698,7 +7992,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "updateDocumentProcessingConfig": {
@@ -7733,7 +8028,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -7775,7 +8071,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -7816,7 +8113,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -7857,7 +8155,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -7895,7 +8194,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -7921,7 +8221,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -7947,7 +8248,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getProcessedDocument": {
@@ -8010,7 +8312,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "import": {
@@ -8039,7 +8342,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -8076,7 +8380,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -8116,7 +8421,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -8145,7 +8451,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -8175,7 +8482,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -8212,7 +8520,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8247,7 +8556,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -8273,7 +8583,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -8320,7 +8631,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8357,7 +8669,8 @@
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/cloud_search.query",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8391,7 +8704,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -8421,7 +8735,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8459,7 +8774,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -8485,7 +8801,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -8511,7 +8828,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -8553,7 +8871,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -8588,7 +8907,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8621,7 +8941,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -8650,7 +8971,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -8676,7 +8998,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -8702,7 +9025,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -8749,7 +9073,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -8784,7 +9109,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8816,7 +9142,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -8863,7 +9190,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8895,7 +9223,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -8942,7 +9271,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8980,7 +9310,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -9006,7 +9337,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -9032,7 +9364,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -9069,7 +9402,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -9103,7 +9437,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -9120,7 +9455,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
+"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -9137,7 +9472,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -9171,7 +9507,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -9197,7 +9534,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -9223,7 +9561,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -9260,7 +9599,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -9295,7 +9635,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "recommend": {
@@ -9324,7 +9665,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "search": {
@@ -9354,7 +9696,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "searchLite": {
@@ -9384,7 +9727,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "streamAnswer": {
@@ -9397,7 +9741,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
+"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -9414,7 +9758,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -9436,6 +9781,11 @@
 "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
 "required": true,
 "type": "string"
+},
+"sessionId": {
+"description": "Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated.",
+"location": "query",
+"type": "string"
 }
 },
 "path": "v1alpha/{+parent}/sessions",
@@ -9448,7 +9798,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -9475,7 +9826,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -9507,7 +9859,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -9555,7 +9908,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -9591,7 +9945,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -9621,7 +9976,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -9656,7 +10012,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "enableAdvancedSiteSearch": {
@@ -9685,7 +10042,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "recrawlUris": {
@@ -9714,7 +10072,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -9747,7 +10106,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -9773,7 +10133,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "fetch": {
@@ -9805,7 +10166,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -9838,7 +10200,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -9867,7 +10230,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -9893,7 +10257,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -9919,7 +10284,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -9956,7 +10322,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -9985,7 +10352,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -10021,7 +10389,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -10051,7 +10420,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -10098,7 +10468,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "import": {
@@ -10128,7 +10499,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -10158,7 +10530,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "write": {
@@ -10193,7 +10566,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -10234,7 +10608,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -10270,7 +10645,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -10306,7 +10682,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -10332,7 +10709,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -10369,7 +10747,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "listResults": {
@@ -10406,7 +10785,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -10436,7 +10816,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -10471,7 +10852,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -10519,7 +10901,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -10545,7 +10928,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -10571,7 +10955,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "importIdentityMappings": {
@@ -10600,7 +10985,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -10637,7 +11023,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "listIdentityMappings": {
@@ -10674,7 +11061,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purgeIdentityMappings": {
@@ -10703,7 +11091,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -10733,7 +11122,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -10780,7 +11170,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -10820,7 +11211,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -10846,7 +11238,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -10881,7 +11274,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -10914,7 +11308,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -10943,7 +11338,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -10969,7 +11365,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "listRecentlyViewed": {
@@ -11006,7 +11403,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "share": {
@@ -11035,7 +11433,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -11068,7 +11467,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -11094,7 +11494,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -11128,7 +11529,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "batchDelete": {
@@ -11157,7 +11559,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -11183,7 +11586,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -11215,7 +11619,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -11262,7 +11667,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -11294,7 +11700,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -11329,7 +11736,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -11362,7 +11770,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -11400,7 +11809,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -11426,7 +11836,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -11452,7 +11863,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -11489,7 +11901,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -11524,7 +11937,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -11554,7 +11968,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -11592,7 +12007,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -11618,7 +12034,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -11644,7 +12061,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "import": {
@@ -11673,7 +12091,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -11710,7 +12129,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -11745,7 +12165,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -11794,7 +12215,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "import": {
@@ -11824,7 +12246,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "write": {
@@ -11859,7 +12282,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -11892,7 +12316,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -11918,7 +12343,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -11953,7 +12379,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -11983,7 +12410,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -12013,7 +12441,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -12060,7 +12489,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -12076,6 +12506,11 @@
 "parent"
 ],
 "parameters": {
+"filter": {
+"description": "Optional. Filter for the list request. Supported fields: * `license_assignment_state` * `user_principal` * Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned. * `user_principal = user1@abc.com` to list user license for `user1@abc.com`.",
+"location": "query",
+"type": "string"
+},
 "orderBy": {
 "description": "Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a \" desc\" suffix. Redundant space characters in the syntax are insignificant. Supported fields (only `user_principal` is supported for now): * `user_principal` If not set, the default ordering is by `user_principal`. Examples: * `user_principal` to order by `user_principal` in ascending order. * `user_principal desc` to order by `user_principal` in descending order.",
 "location": "query",
@@ -12106,7 +12541,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -12140,7 +12576,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -12187,7 +12624,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -12195,7 +12633,7 @@
 }
 }
 },
-"revision": "20260322",
+"revision": "20260413",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "GoogleApiDistribution": {
@@ -12638,6 +13076,10 @@
 "description": "Optional. Action parameters in structured json format.",
 "type": "object"
 },
+"createBapConnection": {
+"description": "Optional. Whether to create a BAP connection for the connector.",
+"type": "boolean"
+},
 "isActionConfigured": {
 "description": "Output only. The connector contains the necessary parameters and is configured to support actions.",
 "readOnly": true,
@@ -12817,6 +13259,12 @@
 "description": "Discovery Engine Assistant resource.",
 "id": "GoogleCloudDiscoveryengineV1Assistant",
 "properties": {
+"createTime": {
+"description": "Output only. Represents the time when this Assistant was created.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
 "customerPolicy": {
 "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicy",
 "description": "Optional. Customer policy for the assistant."
@@ -12848,6 +13296,12 @@
 "description": "Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.",
 "type": "string"
 },
+"updateTime": {
+"description": "Output only. Represents the time when this Assistant was most recently updated.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
 "webGroundingType": {
 "description": "Optional. The type of web grounding to use.",
 "enum": [
@@ -13121,6 +13575,20 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1CliConfig": {
+"description": "The configuration for the CLI execution based connectors.",
+"id": "GoogleCloudDiscoveryengineV1CliConfig",
+"properties": {
+"enabledActions": {
+"description": "Optional. The actions enabled on the associated CLI connection.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1CmekConfig": {
 "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.",
 "id": "GoogleCloudDiscoveryengineV1CmekConfig",
@@ -13672,6 +14140,10 @@
 "readOnly": true,
 "type": "array"
 },
+"cliConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1CliConfig",
+"description": "Optional. The configuration for establishing a CLI connection."
+},
 "connectorModes": {
 "description": "Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.",
 "items": {
@@ -14930,7 +15402,7 @@
 ],
 "type": "string"
 },
-"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails`",
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`",
 "type": "object"
 },
 "industryVertical": {
@@ -17025,6 +17497,10 @@
 "description": "Optional. Action parameters in structured json format.",
 "type": "object"
 },
+"createBapConnection": {
+"description": "Optional. Whether to create a BAP connection for the connector.",
+"type": "boolean"
+},
 "isActionConfigured": {
 "description": "Output only. The connector contains the necessary parameters and is configured to support actions.",
 "readOnly": true,
@@ -17522,7 +17998,8 @@
 "DEPLOYMENT_FAILED",
 "PRIVATE",
 "ENABLED",
-"SUSPENDED"
+"SUSPENDED",
+"CREATING"
 ],
 "enumDescriptions": [
 "The state is unspecified.",
@@ -17532,7 +18009,8 @@
 "The agent deployment failed.",
 "Agent is available only to its creator..",
 "Agent is available for users who have access.",
-"Agent is temporarily unavailable, though visible to users who have access."
+"Agent is temporarily unavailable, though visible to users who have access.",
+"Agent is being created."
 ],
 "readOnly": true,
 "type": "string"
@@ -17837,10 +18315,11 @@
 "type": "string"
 },
 "blobAttachments": {
-"description": "List of blob attachments in the answer.",
+"description": "Output only. List of blob attachments in the answer.",
 "items": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment"
 },
+"readOnly": true,
 "type": "array"
 },
 "citations": {
@@ -18512,7 +18991,7 @@
 },
 "customFineTuningSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec",
-"description": "Custom fine tuning configs."
+"description": "Optional. Custom fine tuning configs."
 },
 "dataStoreSpecs": {
 "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.",
@@ -19229,6 +19708,11 @@
 "description": "One part of the multi-part response of the assist call.",
 "id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerReply",
 "properties": {
+"createTime": {
+"description": "The time when the reply was created.",
+"format": "google-datetime",
+"type": "string"
+},
 "groundedContent": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent",
 "description": "Possibly grounded response text or media from the assistant."
@@ -19260,6 +19744,12 @@
 "description": "Discovery Engine Assistant resource.",
 "id": "GoogleCloudDiscoveryengineV1alphaAssistant",
 "properties": {
+"createTime": {
+"description": "Output only. Represents the time when this Assistant was created.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
 "customerPolicy": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicy",
 "description": "Optional. Customer policy for the assistant."
@@ -19295,6 +19785,12 @@
 "description": "Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.",
 "type": "string"
 },
+"updateTime": {
+"description": "Output only. Represents the time when this Assistant was most recently updated.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
 "webGroundingType": {
 "description": "Optional. The type of web grounding to use.",
 "enum": [
@@ -20897,6 +21393,20 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaCliConfig": {
+"description": "The configuration for the CLI execution based connectors.",
+"id": "GoogleCloudDiscoveryengineV1alphaCliConfig",
+"properties": {
+"enabledActions": {
+"description": "Optional. The actions enabled on the associated CLI connection.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaCloudSqlSource": {
 "description": "Cloud SQL source import data from.",
 "id": "GoogleCloudDiscoveryengineV1alphaCloudSqlSource",
@@ -22116,6 +22626,10 @@
 "readOnly": true,
 "type": "array"
 },
+"cliConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaCliConfig",
+"description": "Optional. The configuration for establishing a CLI connection."
+},
 "connectorModes": {
 "description": "Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.",
 "items": {
@@ -22647,6 +23161,10 @@
 "readOnly": true,
 "type": "string"
 },
+"dataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy",
+"description": "Optional. Specifies the data protection policy for the data store."
+},
 "defaultSchemaId": {
 "description": "Output only. The id of the default Schema associated to this data store.",
 "readOnly": true,
@@ -23752,7 +24270,7 @@
 ],
 "type": "string"
 },
-"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails`",
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`",
 "type": "object"
 },
 "industryVertical": {
@@ -28597,6 +29115,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec",
 "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec."
 },
+"customRankingParams": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams",
+"description": "Optional. Optional configuration for the Custom Ranking feature."
+},
 "dataStoreSpecs": {
 "description": "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. For engines with a single data store, the specs directly under SearchRequest should be used.",
 "items": {
@@ -28612,6 +29134,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec",
 "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path."
 },
+"entity": {
+"description": "Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, \"Google US\", \"Google Ads\", \"Waymo\", \"google.com\", \"youtube.com\", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity.",
+"type": "string"
+},
 "facetSpecs": {
 "description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "items": {
@@ -29126,6 +29652,20 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams": {
+"description": "Configuration parameters for the Custom Ranking feature.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams",
+"properties": {
+"expressionsToPrecompute": {
+"description": "Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": {
 "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec",
@@ -29333,7 +29873,7 @@ false
 "type": "string"
 },
 "geoSearchQueryDetectionFieldNames": {
-"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.",
+"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`.",
 "items": {
 "type": "string"
 },
@@ -30024,6 +30564,14 @@ false
 "format": "float",
 "type": "number"
 },
+"precomputedExpressionValues": {
+"description": "Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`.",
+"items": {
+"format": "float",
+"type": "number"
+},
+"type": "array"
+},
 "relevanceScore": {
 "description": "Optional. Semantic relevance adjustment.",
 "format": "float",
@@ -31577,6 +32125,10 @@ false
 "description": "Information of an end user.",
 "id": "GoogleCloudDiscoveryengineV1alphaUserInfo",
 "properties": {
+"preciseLocation": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation",
+"description": "Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents."
+},
 "timeZone": {
 "description": "Optional. IANA time zone, e.g. Europe/Budapest.",
 "type": "string"
@@ -31592,6 +32144,21 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation": {
+"description": "Precise location info with multiple representation options. Currently only latitude and longitude point is supported.",
+"id": "GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation",
+"properties": {
+"address": {
+"description": "Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.",
+"type": "string"
+},
+"point": {
+"$ref": "GoogleTypeLatLng",
+"description": "Optional. Location represented by a latitude/longitude point."
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaUserLicense": {
 "description": "User License information assigned by the admin.",
 "id": "GoogleCloudDiscoveryengineV1alphaUserLicense",
@@ -32457,7 +33024,7 @@ false
 ],
 "type": "string"
 },
-"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails`",
+"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`",
 "readOnly": true,
 "type": "object"
 },
@@ -34005,7 +34572,7 @@ false
 ],
 "type": "string"
 },
-"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails`",
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`",
 "type": "object"
 },
 "industryVertical": {
@@ -35559,6 +36126,10 @@ false
 },
 "type": "array"
 },
+"customRankingParams": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams",
+"description": "Optional. Optional configuration for the Custom Ranking feature."
+},
 "dataStoreSpecs": {
 "description": "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. For engines with a single data store, the specs directly under SearchRequest should be used.",
 "items": {
@@ -35574,6 +36145,10 @@ false
 "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec",
 "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path."
 },
+"entity": {
+"description": "Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, \"Google US\", \"Google Ads\", \"Waymo\", \"google.com\", \"youtube.com\", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity.",
+"type": "string"
+},
 "facetSpecs": {
 "description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "items": {
@@ -36084,6 +36659,20 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams": {
+"description": "Configuration parameters for the Custom Ranking feature.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams",
+"properties": {
+"expressionsToPrecompute": {
+"description": "Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": {
 "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec",
@@ -36291,7 +36880,7 @@ false
 "type": "string"
 },
 "geoSearchQueryDetectionFieldNames": {
-"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.",
+"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`.",
 "items": {
 "type": "string"
 },
@@ -36797,6 +37386,10 @@ false
 "description": "Information of an end user.",
 "id": "GoogleCloudDiscoveryengineV1betaUserInfo",
 "properties": {
+"preciseLocation": {
+"$ref": "GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation",
+"description": "Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents."
+},
 "timeZone": {
 "description": "Optional. IANA time zone, e.g. Europe/Budapest.",
 "type": "string"
@@ -36812,6 +37405,21 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation": {
+"description": "Precise location info with multiple representation options. Currently only latitude and longitude point is supported.",
+"id": "GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation",
+"properties": {
+"address": {
+"description": "Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.",
+"type": "string"
+},
+"point": {
+"$ref": "GoogleTypeLatLng",
+"description": "Optional. Location represented by a latitude/longitude point."
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaUserLicense": {
 "description": "User License information assigned by the admin.",
 "id": "GoogleCloudDiscoveryengineV1betaUserLicense",
@@ -38122,6 +38730,23 @@ false
 },
 "type": "object"
 },
+"GoogleTypeLatLng": {
+"description": "An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.",
+"id": "GoogleTypeLatLng",
+"properties": {
+"latitude": {
+"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+"format": "double",
+"type": "number"
+},
+"longitude": {
+"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+"format": "double",
+"type": "number"
+}
+},
+"type": "object"
+},
 "GoogleTypeTimeZone": {
 "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).",
 "id": "GoogleTypeTimeZone",
diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json
index 7962dbd09a..821e9d22f9 100644
--- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json
@@ -13,6 +13,9 @@
 },
 "https://www.googleapis.com/auth/discoveryengine.readwrite": {
 "description": "View, edit, create, and delete all your data associated with any Discovery Engine API product, such as Agentspace, Vertex AI Search, or NotebookLM Enterprise, including both end user data and administration or configuration data."
+},
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite": {
+"description": "Interact with Discovery Engine API products, such as Agentspace, Vertex AI Search, or NotebookLM Enterprise, on your behalf. It will also allow the app to view all data that you have access to when you use or interact with a Discovery Engine API product."
 }
 }
 }
@@ -141,6 +144,74 @@
 },
 "protocol": "rest",
 "resources": {
+"billingAccounts": {
+"resources": {
+"billingAccountLicenseConfigs": {
+"methods": {
+"distributeLicenseConfig": {
+"description": "Distributes a LicenseConfig from billing account level to project level.",
+"flatPath": "v1beta/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}:distributeLicenseConfig",
+"httpMethod": "POST",
+"id": "discoveryengine.billingAccounts.billingAccountLicenseConfigs.distributeLicenseConfig",
+"parameterOrder": [
+"billingAccountLicenseConfig"
+],
+"parameters": {
+"billingAccountLicenseConfig": {
+"description": "Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.",
+"location": "path",
+"pattern": "^billingAccounts/[^/]+/billingAccountLicenseConfigs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta/{+billingAccountLicenseConfig}:distributeLicenseConfig",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1betaDistributeLicenseConfigRequest"
+},
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1betaDistributeLicenseConfigResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
+]
+},
+"retractLicenseConfig": {
+"description": "This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.",
+"flatPath": "v1beta/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}:retractLicenseConfig",
+"httpMethod": "POST",
+"id": "discoveryengine.billingAccounts.billingAccountLicenseConfigs.retractLicenseConfig",
+"parameterOrder": [
+"billingAccountLicenseConfig"
+],
+"parameters": {
+"billingAccountLicenseConfig": {
+"description": "Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.",
+"location": "path",
+"pattern": "^billingAccounts/[^/]+/billingAccountLicenseConfigs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta/{+billingAccountLicenseConfig}:retractLicenseConfig",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1betaRetractLicenseConfigRequest"
+},
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1betaRetractLicenseConfigResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
+]
+}
+}
+}
+}
+},
 "projects": {
 "methods": {
 "provision": {
@@ -169,7 +240,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -199,7 +271,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getCmekConfig": {
@@ -225,7 +298,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "obtainCrawlRate": {
@@ -254,7 +328,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "removeDedicatedCrawlRate": {
@@ -283,7 +358,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "setDedicatedCrawlRate": {
@@ -312,7 +388,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "updateAclConfig": {
@@ -341,7 +418,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "updateCmekConfig": {
@@ -375,7 +453,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -405,7 +484,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -431,7 +511,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -457,7 +538,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -491,7 +573,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -525,7 +608,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -572,7 +656,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -625,7 +710,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -679,7 +765,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -705,7 +792,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -731,7 +819,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getSiteSearchEngine": {
@@ -757,7 +846,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -799,7 +889,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -834,7 +925,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "trainCustomModel": {
@@ -863,7 +955,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -905,7 +998,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -943,7 +1037,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -969,7 +1064,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -995,7 +1091,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "import": {
@@ -1024,7 +1121,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -1061,7 +1159,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -1101,7 +1200,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -1130,7 +1230,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1163,7 +1264,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -1189,7 +1291,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -1236,7 +1339,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1273,7 +1377,8 @@
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/cloud_search.query",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1307,7 +1412,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -1337,7 +1443,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1375,7 +1482,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -1401,7 +1509,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -1427,7 +1536,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -1469,7 +1579,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -1504,7 +1615,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1537,7 +1649,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -1566,7 +1679,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -1592,7 +1706,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -1618,7 +1733,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -1665,7 +1781,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -1700,7 +1817,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1730,7 +1848,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1762,7 +1881,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -1809,7 +1929,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1841,7 +1962,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -1888,7 +2010,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -1926,7 +2049,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -1952,7 +2076,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -1978,7 +2103,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -2015,7 +2141,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -2049,7 +2176,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -2079,7 +2207,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -2126,7 +2255,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -2145,7 +2275,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
+"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -2161,7 +2291,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -2195,7 +2326,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -2221,7 +2353,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -2247,7 +2380,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -2284,7 +2418,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -2319,7 +2454,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "recommend": {
@@ -2348,7 +2484,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "search": {
@@ -2378,7 +2515,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "searchLite": {
@@ -2408,7 +2546,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "streamAnswer": {
@@ -2421,7 +2560,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
+"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -2437,7 +2576,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -2459,6 +2599,11 @@
 "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$",
 "required": true,
 "type": "string"
+},
+"sessionId": {
+"description": "Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated.",
+"location": "query",
+"type": "string"
 }
 },
 "path": "v1beta/{+parent}/sessions",
@@ -2471,7 +2616,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -2498,7 +2644,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -2530,7 +2677,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -2578,7 +2726,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -2614,7 +2763,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -2644,7 +2794,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -2679,7 +2830,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "disableAdvancedSiteSearch": {
@@ -2708,7 +2860,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "enableAdvancedSiteSearch": {
@@ -2737,7 +2890,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "fetchDomainVerificationStatus": {
@@ -2774,7 +2928,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "recrawlUris": {
@@ -2803,7 +2958,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -2833,7 +2989,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -2880,7 +3037,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -2913,7 +3071,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -2939,7 +3098,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "fetch": {
@@ -2971,7 +3131,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -3004,7 +3165,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -3033,7 +3195,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -3059,7 +3222,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -3085,7 +3249,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -3122,7 +3287,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -3151,7 +3317,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -3181,7 +3348,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -3228,7 +3396,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -3266,7 +3435,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -3296,7 +3466,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -3343,7 +3514,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "import": {
@@ -3373,7 +3545,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -3403,7 +3576,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "write": {
@@ -3438,7 +3612,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -3478,7 +3653,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -3504,7 +3680,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -3530,7 +3707,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getIamPolicy": {
@@ -3562,7 +3740,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -3604,7 +3783,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -3639,7 +3819,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "pause": {
@@ -3668,7 +3849,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "resume": {
@@ -3697,7 +3879,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "setIamPolicy": {
@@ -3726,7 +3909,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "tune": {
@@ -3755,7 +3939,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -3794,7 +3979,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -3821,7 +4007,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -3848,7 +4035,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -3886,7 +4074,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -3922,7 +4111,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "streamAssist": {
@@ -3952,7 +4142,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -3984,7 +4175,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -4023,7 +4215,8 @@
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/cloud_search.query",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "removeSuggestion": {
@@ -4053,7 +4246,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -4091,7 +4285,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -4117,7 +4312,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -4143,7 +4339,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -4185,7 +4382,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -4220,7 +4418,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -4253,7 +4452,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -4282,7 +4482,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -4308,7 +4509,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -4334,7 +4536,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -4381,7 +4584,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -4416,7 +4620,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -4446,7 +4651,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -4493,7 +4699,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -4510,7 +4717,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
+"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -4526,7 +4733,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -4560,7 +4768,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -4586,7 +4795,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -4612,7 +4822,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -4649,7 +4860,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -4684,7 +4896,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "recommend": {
@@ -4713,7 +4926,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "search": {
@@ -4743,7 +4957,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "searchLite": {
@@ -4773,7 +4988,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "streamAnswer": {
@@ -4786,7 +5002,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
+"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -4802,7 +5018,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -4824,6 +5041,11 @@
 "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$",
 "required": true,
 "type": "string"
+},
+"sessionId": {
+"description": "Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated.",
+"location": "query",
+"type": "string"
 }
 },
 "path": "v1beta/{+parent}/sessions",
@@ -4836,7 +5058,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -4863,7 +5086,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -4895,7 +5119,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -4943,7 +5168,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -4979,7 +5205,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -5009,7 +5236,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -5043,7 +5271,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -5090,7 +5319,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -5143,7 +5373,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -5197,7 +5428,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -5223,7 +5455,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -5249,7 +5482,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "getSiteSearchEngine": {
@@ -5275,7 +5509,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -5317,7 +5552,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -5352,7 +5588,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -5394,7 +5631,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -5432,7 +5670,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -5458,7 +5697,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -5484,7 +5724,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "import": {
@@ -5513,7 +5754,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -5550,7 +5792,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -5590,7 +5833,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -5619,7 +5863,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -5652,7 +5897,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -5678,7 +5924,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -5725,7 +5972,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -5762,7 +6010,8 @@
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/cloud_search.query",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -5796,7 +6045,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -5826,7 +6076,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -5864,7 +6115,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -5890,7 +6142,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -5916,7 +6169,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -5958,7 +6212,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -5993,7 +6248,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -6026,7 +6282,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -6055,7 +6312,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -6081,7 +6339,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -6107,7 +6366,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -6154,7 +6414,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -6189,7 +6450,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -6221,7 +6483,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -6268,7 +6531,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -6300,7 +6564,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -6347,7 +6612,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -6385,7 +6651,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -6411,7 +6678,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -6437,7 +6705,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -6474,7 +6743,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -6508,7 +6778,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -6525,7 +6796,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
+"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -6541,7 +6812,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -6575,7 +6847,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -6601,7 +6874,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -6627,7 +6901,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -6664,7 +6939,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -6699,7 +6975,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "recommend": {
@@ -6728,7 +7005,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "search": {
@@ -6758,7 +7036,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "searchLite": {
@@ -6788,7 +7067,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "streamAnswer": {
@@ -6801,7 +7081,7 @@
 ],
 "parameters": {
 "servingConfig": {
-"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
+"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$",
 "required": true,
@@ -6817,7 +7097,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -6839,6 +7120,11 @@
 "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$",
 "required": true,
 "type": "string"
+},
+"sessionId": {
+"description": "Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated.",
+"location": "query",
+"type": "string"
 }
 },
 "path": "v1beta/{+parent}/sessions",
@@ -6851,7 +7137,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -6878,7 +7165,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -6910,7 +7198,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -6958,7 +7247,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -6994,7 +7284,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -7024,7 +7315,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -7059,7 +7351,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "enableAdvancedSiteSearch": {
@@ -7088,7 +7381,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "recrawlUris": {
@@ -7117,7 +7411,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -7150,7 +7445,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -7176,7 +7472,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "fetch": {
@@ -7208,7 +7505,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -7241,7 +7539,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "create": {
@@ -7270,7 +7569,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -7296,7 +7596,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -7322,7 +7623,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -7359,7 +7661,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -7388,7 +7691,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -7424,7 +7728,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -7454,7 +7759,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -7501,7 +7807,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "import": {
@@ -7531,7 +7838,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purge": {
@@ -7561,7 +7869,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "write": {
@@ -7596,7 +7905,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -7632,7 +7942,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -7658,7 +7969,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -7695,7 +8007,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "listResults": {
@@ -7732,7 +8045,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -7762,7 +8076,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -7797,7 +8112,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -7845,7 +8161,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -7871,7 +8188,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -7897,7 +8215,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "importIdentityMappings": {
@@ -7926,7 +8245,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -7963,7 +8283,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "listIdentityMappings": {
@@ -8000,7 +8321,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "purgeIdentityMappings": {
@@ -8029,7 +8351,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -8059,7 +8382,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -8106,7 +8430,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8146,7 +8471,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -8172,7 +8498,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -8207,7 +8534,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8237,7 +8565,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -8284,7 +8613,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8316,7 +8646,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8351,7 +8682,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8389,7 +8721,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -8415,7 +8748,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -8441,7 +8775,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -8478,7 +8813,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -8513,7 +8849,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -8543,7 +8880,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8581,7 +8919,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "delete": {
@@ -8607,7 +8946,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -8633,7 +8973,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "import": {
@@ -8662,7 +9003,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -8699,7 +9041,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -8734,7 +9077,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8783,7 +9127,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "import": {
@@ -8813,7 +9158,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "write": {
@@ -8848,7 +9194,8 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/discoveryengine.assist.readwrite",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8881,7 +9228,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "get": {
@@ -8907,7 +9255,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "patch": {
@@ -8942,7 +9291,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 },
@@ -8972,7 +9322,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -8988,6 +9339,11 @@
 "parent"
 ],
 "parameters": {
+"filter": {
+"description": "Optional. Filter for the list request. Supported fields: * `license_assignment_state` * `user_principal` * Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned. * `user_principal = user1@abc.com` to list user license for `user1@abc.com`.",
+"location": "query",
+"type": "string"
+},
 "orderBy": {
 "description": "Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a \" desc\" suffix. Redundant space characters in the syntax are insignificant. Supported fields (only `user_principal` is supported for now): * `user_principal` If not set, the default ordering is by `user_principal`. Examples: * `user_principal` to order by `user_principal` in ascending order. * `user_principal desc` to order by `user_principal` in descending order.",
 "location": "query",
@@ -9018,7 +9374,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -9052,7 +9409,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 },
 "list": {
@@ -9099,7 +9457,8 @@
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/discoveryengine.readwrite"
+"https://www.googleapis.com/auth/discoveryengine.readwrite",
+"https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
 ]
 }
 }
@@ -9107,7 +9466,7 @@
 }
 }
 },
-"revision": "20260322",
+"revision": "20260413",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "GoogleApiDistribution": {
@@ -9550,6 +9909,10 @@
 "description": "Optional. Action parameters in structured json format.",
 "type": "object"
 },
+"createBapConnection": {
+"description": "Optional. Whether to create a BAP connection for the connector.",
+"type": "boolean"
+},
 "isActionConfigured": {
 "description": "Output only. The connector contains the necessary parameters and is configured to support actions.",
 "readOnly": true,
@@ -9729,6 +10092,12 @@
 "description": "Discovery Engine Assistant resource.",
 "id": "GoogleCloudDiscoveryengineV1Assistant",
 "properties": {
+"createTime": {
+"description": "Output only. Represents the time when this Assistant was created.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
 "customerPolicy": {
 "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicy",
 "description": "Optional. Customer policy for the assistant."
@@ -9760,6 +10129,12 @@
 "description": "Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.",
 "type": "string"
 },
+"updateTime": {
+"description": "Output only. Represents the time when this Assistant was most recently updated.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
 "webGroundingType": {
 "description": "Optional. The type of web grounding to use.",
 "enum": [
@@ -10033,6 +10408,20 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1CliConfig": {
+"description": "The configuration for the CLI execution based connectors.",
+"id": "GoogleCloudDiscoveryengineV1CliConfig",
+"properties": {
+"enabledActions": {
+"description": "Optional. The actions enabled on the associated CLI connection.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1CmekConfig": {
 "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.",
 "id": "GoogleCloudDiscoveryengineV1CmekConfig",
@@ -10584,6 +10973,10 @@
 "readOnly": true,
 "type": "array"
 },
+"cliConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1CliConfig",
+"description": "Optional. The configuration for establishing a CLI connection."
+},
 "connectorModes": {
 "description": "Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.",
 "items": {
@@ -11842,7 +12235,7 @@
 ],
 "type": "string"
 },
-"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails`",
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`",
 "type": "object"
 },
 "industryVertical": {
@@ -13885,6 +14278,10 @@
 "description": "Optional. Action parameters in structured json format.",
 "type": "object"
 },
+"createBapConnection": {
+"description": "Optional. Whether to create a BAP connection for the connector.",
+"type": "boolean"
+},
 "isActionConfigured": {
 "description": "Output only. The connector contains the necessary parameters and is configured to support actions.",
 "readOnly": true,
@@ -14133,10 +14530,11 @@
 "type": "string"
 },
 "blobAttachments": {
-"description": "List of blob attachments in the answer.",
+"description": "Output only. List of blob attachments in the answer.",
 "items": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment"
 },
+"readOnly": true,
 "type": "array"
 },
 "citations": {
@@ -14846,6 +15244,11 @@
 "description": "One part of the multi-part response of the assist call.",
 "id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerReply",
 "properties": {
+"createTime": {
+"description": "The time when the reply was created.",
+"format": "google-datetime",
+"type": "string"
+},
 "groundedContent": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent",
 "description": "Possibly grounded response text or media from the assistant."
@@ -15248,6 +15651,20 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaCliConfig": {
+"description": "The configuration for the CLI execution based connectors.",
+"id": "GoogleCloudDiscoveryengineV1alphaCliConfig",
+"properties": {
+"enabledActions": {
+"description": "Optional. The actions enabled on the associated CLI connection.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaCmekConfig": {
 "description": "Configurations used to enable CMEK data encryption with Cloud KMS keys.",
 "id": "GoogleCloudDiscoveryengineV1alphaCmekConfig",
@@ -16067,6 +16484,10 @@
 "readOnly": true,
 "type": "array"
 },
+"cliConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaCliConfig",
+"description": "Optional. The configuration for establishing a CLI connection."
+},
 "connectorModes": {
 "description": "Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.",
 "items": {
@@ -16598,6 +17019,10 @@
 "readOnly": true,
 "type": "string"
 },
+"dataProtectionPolicy": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy",
+"description": "Optional. Specifies the data protection policy for the data store."
+},
 "defaultSchemaId": {
 "description": "Output only. The id of the default Schema associated to this data store.",
 "readOnly": true,
@@ -17439,7 +17864,7 @@
 ],
 "type": "string"
 },
-"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails`",
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`",
 "type": "object"
 },
 "industryVertical": {
@@ -19915,6 +20340,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec",
 "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec."
 },
+"customRankingParams": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams",
+"description": "Optional. Optional configuration for the Custom Ranking feature."
+},
 "dataStoreSpecs": {
 "description": "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. For engines with a single data store, the specs directly under SearchRequest should be used.",
 "items": {
@@ -19930,6 +20359,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec",
 "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path."
 },
+"entity": {
+"description": "Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, \"Google US\", \"Google Ads\", \"Waymo\", \"google.com\", \"youtube.com\", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity.",
+"type": "string"
+},
 "facetSpecs": {
 "description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "items": {
@@ -20444,6 +20877,20 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams": {
+"description": "Configuration parameters for the Custom Ranking feature.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestCustomRankingParams",
+"properties": {
+"expressionsToPrecompute": {
+"description": "Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": {
 "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec",
@@ -20651,7 +21098,7 @@ false
 "type": "string"
 },
 "geoSearchQueryDetectionFieldNames": {
-"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.",
+"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`.",
 "items": {
 "type": "string"
 },
@@ -21348,6 +21795,10 @@ false
 "description": "Information of an end user.",
 "id": "GoogleCloudDiscoveryengineV1alphaUserInfo",
 "properties": {
+"preciseLocation": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation",
+"description": "Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents."
+},
 "timeZone": {
 "description": "Optional. IANA time zone, e.g. Europe/Budapest.",
 "type": "string"
@@ -21363,6 +21814,21 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation": {
+"description": "Precise location info with multiple representation options. Currently only latitude and longitude point is supported.",
+"id": "GoogleCloudDiscoveryengineV1alphaUserInfoPreciseLocation",
+"properties": {
+"address": {
+"description": "Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.",
+"type": "string"
+},
+"point": {
+"$ref": "GoogleTypeLatLng",
+"description": "Optional. Location represented by a latitude/longitude point."
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaUserLicense": {
 "description": "User License information assigned by the admin.",
 "id": "GoogleCloudDiscoveryengineV1alphaUserLicense",
@@ -21905,10 +22371,11 @@ false
 "type": "string"
 },
 "blobAttachments": {
-"description": "List of blob attachments in the answer.",
+"description": "Output only. List of blob attachments in the answer.",
 "items": {
 "$ref": "GoogleCloudDiscoveryengineV1betaAnswerBlobAttachment"
 },
+"readOnly": true,
 "type": "array"
 },
 "citations": {
@@ -23293,6 +23760,11 @@ false
 "description": "One part of the multi-part response of the assist call.",
 "id": "GoogleCloudDiscoveryengineV1betaAssistAnswerReply",
 "properties": {
+"createTime": {
+"description": "The time when the reply was created.",
+"format": "google-datetime",
+"type": "string"
+},
 "groundedContent": {
 "$ref": "GoogleCloudDiscoveryengineV1betaAssistantGroundedContent",
 "description": "Possibly grounded response text or media from the assistant."
@@ -23319,6 +23791,12 @@ false
 "description": "Discovery Engine Assistant resource.",
 "id": "GoogleCloudDiscoveryengineV1betaAssistant",
 "properties": {
+"createTime": {
+"description": "Output only. Represents the time when this Assistant was created.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
 "customerPolicy": {
 "$ref": "GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicy",
 "description": "Optional. Customer policy for the assistant."
@@ -23350,6 +23828,12 @@ false
 "description": "Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters.",
 "type": "string"
 },
+"updateTime": {
+"description": "Output only. Represents the time when this Assistant was most recently updated.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
 "webGroundingType": {
 "description": "Optional. The type of web grounding to use.",
 "enum": [
@@ -25825,6 +26309,42 @@ false
 "properties": {},
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaDistributeLicenseConfigRequest": {
+"description": "Request message for LicenseConfigService.DistributeLicenseConfig method.",
+"id": "GoogleCloudDiscoveryengineV1betaDistributeLicenseConfigRequest",
+"properties": {
+"licenseConfigId": {
+"description": "Optional. Distribute seats to this license config instead of creating a new one. If not specified, a new license config will be created from the billing account license config.",
+"type": "string"
+},
+"licenseCount": {
+"description": "Required. The number of licenses to distribute.",
+"format": "int64",
+"type": "string"
+},
+"location": {
+"description": "Required. The target GCP project region to distribute the license config to.",
+"type": "string"
+},
+"projectNumber": {
+"description": "Required. The target GCP project number to distribute the license config to.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaDistributeLicenseConfigResponse": {
+"description": "Response message for LicenseConfigService.DistributeLicenseConfig method.",
+"id": "GoogleCloudDiscoveryengineV1betaDistributeLicenseConfigResponse",
+"properties": {
+"licenseConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1betaLicenseConfig",
+"description": "The updated or created LicenseConfig."
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaDocument": {
 "description": "Document captures all raw metadata information of items to be recommended or searched.",
 "id": "GoogleCloudDiscoveryengineV1betaDocument",
@@ -26299,7 +26819,7 @@ false
 ],
 "type": "string"
 },
-"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails`",
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`",
 "type": "object"
 },
 "industryVertical": {
@@ -29184,6 +29704,37 @@ false
 "properties": {},
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaRetractLicenseConfigRequest": {
+"description": "Request message for LicenseConfigService.RetractLicenseConfig method.",
+"id": "GoogleCloudDiscoveryengineV1betaRetractLicenseConfigRequest",
+"properties": {
+"fullRetract": {
+"description": "Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count.",
+"type": "boolean"
+},
+"licenseConfig": {
+"description": "Required. Full resource name of LicenseConfig. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config_id}`.",
+"type": "string"
+},
+"licenseCount": {
+"description": "Optional. The number of licenses to retract. Only used when full_retract is false.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaRetractLicenseConfigResponse": {
+"description": "Response message for LicenseConfigService.RetractLicenseConfig method.",
+"id": "GoogleCloudDiscoveryengineV1betaRetractLicenseConfigResponse",
+"properties": {
+"licenseConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1betaLicenseConfig",
+"description": "The updated LicenseConfig."
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaSafetyRating": {
 "description": "Safety rating corresponding to the generated content.",
 "id": "GoogleCloudDiscoveryengineV1betaSafetyRating",
@@ -29456,6 +30007,10 @@ false
 },
 "type": "array"
 },
+"customRankingParams": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams",
+"description": "Optional. Optional configuration for the Custom Ranking feature."
+},
 "dataStoreSpecs": {
 "description": "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. For engines with a single data store, the specs directly under SearchRequest should be used.",
 "items": {
@@ -29471,6 +30026,10 @@ false
 "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec",
 "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path."
 },
+"entity": {
+"description": "Optional. The entity for customers that may run multiple different entities, domains, sites or regions, for example, \"Google US\", \"Google Ads\", \"Waymo\", \"google.com\", \"youtube.com\", etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity.",
+"type": "string"
+},
 "facetSpecs": {
 "description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "items": {
@@ -29981,6 +30540,20 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams": {
+"description": "Configuration parameters for the Custom Ranking feature.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestCustomRankingParams",
+"properties": {
+"expressionsToPrecompute": {
+"description": "Optional. A list of ranking expressions (see `ranking_expression` for the syntax documentation) to evaluate. The evaluation results will be returned in `SearchResponse.SearchResult.rank_signals.precomputed_expression_values` field.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": {
 "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec",
@@ -30188,7 +30761,7 @@ false
 "type": "string"
 },
 "geoSearchQueryDetectionFieldNames": {
-"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.",
+"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`.",
 "items": {
 "type": "string"
 },
@@ -30879,6 +31452,14 @@ false
 "format": "float",
 "type": "number"
 },
+"precomputedExpressionValues": {
+"description": "Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`.",
+"items": {
+"format": "float",
+"type": "number"
+},
+"type": "array"
+},
 "relevanceScore": {
 "description": "Optional. Semantic relevance adjustment.",
 "format": "float",
@@ -32228,6 +32809,10 @@ false
 "description": "Information of an end user.",
 "id": "GoogleCloudDiscoveryengineV1betaUserInfo",
 "properties": {
+"preciseLocation": {
+"$ref": "GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation",
+"description": "Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents."
+},
 "timeZone": {
 "description": "Optional. IANA time zone, e.g. Europe/Budapest.",
 "type": "string"
@@ -32243,6 +32828,21 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation": {
+"description": "Precise location info with multiple representation options. Currently only latitude and longitude point is supported.",
+"id": "GoogleCloudDiscoveryengineV1betaUserInfoPreciseLocation",
+"properties": {
+"address": {
+"description": "Optional. Location represented by a natural language address. Will later be geocoded and converted to either a point or a polygon.",
+"type": "string"
+},
+"point": {
+"$ref": "GoogleTypeLatLng",
+"description": "Optional. Location represented by a latitude/longitude point."
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaUserLicense": {
 "description": "User License information assigned by the admin.",
 "id": "GoogleCloudDiscoveryengineV1betaUserLicense",
@@ -32758,6 +33358,23 @@ false
 },
 "type": "object"
 },
+"GoogleTypeLatLng": {
+"description": "An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.",
+"id": "GoogleTypeLatLng",
+"properties": {
+"latitude": {
+"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+"format": "double",
+"type": "number"
+},
+"longitude": {
+"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+"format": "double",
+"type": "number"
+}
+},
+"type": "object"
+},
 "GoogleTypeTimeZone": {
 "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).",
 "id": "GoogleTypeTimeZone",

From 074a676ae691bf82895c8de81d4862fac1ad6540 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 14 Apr 2026 07:41:00 +0000
Subject: [PATCH 15/32] feat(displayvideo): update the api

#### displayvideo:v2

The following keys were deleted:
- resources.inventorySources.methods.create (Total Keys: 14)
- resources.inventorySources.methods.editInventorySourceReadWriteAccessors (Total Keys: 13)
- resources.inventorySources.methods.get (Total Keys: 15)
- resources.inventorySources.methods.list (Total Keys: 22)
- resources.inventorySources.methods.patch (Total Keys: 22)
- schemas.CreativeConfig (Total Keys: 5)
- schemas.EditInventorySourceReadWriteAccessorsRequest (Total Keys: 14)
- schemas.InventorySource (Total Keys: 64)
- schemas.ListInventorySourcesResponse (Total Keys: 5)
- schemas.Money (Total Keys: 7)
- schemas.RateDetails (Total Keys: 8)
- schemas.TimeRange (Total Keys: 6)

The following keys were added:
- schemas.LineItem.properties.optimizeFixedBidding.type (Total Keys: 1)

#### displayvideo:v3

The following keys were deleted:
- resources.inventorySources.methods.create (Total Keys: 14)
- resources.inventorySources.methods.editInventorySourceReadWriteAccessors (Total Keys: 13)
- resources.inventorySources.methods.get (Total Keys: 18)
- resources.inventorySources.methods.list (Total Keys: 22)
- resources.inventorySources.methods.patch (Total Keys: 22)
- schemas.CreativeConfig (Total Keys: 5)
- schemas.EditInventorySourceReadWriteAccessorsRequest (Total Keys: 14)
- schemas.InventorySource (Total Keys: 64)
- schemas.ListInventorySourcesResponse (Total Keys: 5)
- schemas.Money (Total Keys: 7)
- schemas.RateDetails (Total Keys: 8)
- schemas.TimeRange (Total Keys: 6)

The following keys were added:
- schemas.LineItem.properties.optimizeFixedBidding.type (Total Keys: 1)

#### displayvideo:v4

The following keys were added:
- schemas.LineItem.properties.optimizeFixedBidding.type (Total Keys: 1)
---
 docs/dyn/displayvideo_v2.advertisers.html     |   16 +-
 ...yvideo_v2.advertisers.insertionOrders.html |   36 +-
 ...displayvideo_v2.advertisers.lineItems.html |  183 +--
 ...rgetingTypes.assignedTargetingOptions.html |   20 +-
 ...rgetingTypes.assignedTargetingOptions.html |   20 +-
 ...ideo_v2.advertisers.youtubeAdGroupAds.html |   48 +-
 ...yvideo_v2.advertisers.youtubeAdGroups.html |    8 +-
 ...rgetingTypes.assignedTargetingOptions.html |    8 +-
 docs/dyn/displayvideo_v2.html                 |    5 -
 docs/dyn/displayvideo_v2.partners.html        |    8 +-
 ...rgetingTypes.assignedTargetingOptions.html |   16 +-
 ...isplayvideo_v3.advertisers.adGroupAds.html |  290 ++---
 .../displayvideo_v3.advertisers.adGroups.html |   96 +-
 ...rgetingTypes.assignedTargetingOptions.html |   24 +-
 docs/dyn/displayvideo_v3.advertisers.html     |   16 +-
 ...yvideo_v3.advertisers.insertionOrders.html |   36 +-
 ...displayvideo_v3.advertisers.lineItems.html |  197 ++--
 ...rgetingTypes.assignedTargetingOptions.html |   20 +-
 ...rgetingTypes.assignedTargetingOptions.html |   20 +-
 docs/dyn/displayvideo_v3.html                 |    5 -
 docs/dyn/displayvideo_v3.partners.html        |    8 +-
 ...rgetingTypes.assignedTargetingOptions.html |   16 +-
 ...isplayvideo_v4.advertisers.adGroupAds.html |  290 ++---
 .../displayvideo_v4.advertisers.adGroups.html |   96 +-
 ...rgetingTypes.assignedTargetingOptions.html |   24 +-
 docs/dyn/displayvideo_v4.advertisers.html     |   16 +-
 ...yvideo_v4.advertisers.insertionOrders.html |   36 +-
 ...displayvideo_v4.advertisers.lineItems.html |  197 ++--
 ...rgetingTypes.assignedTargetingOptions.html |   20 +-
 ...rgetingTypes.assignedTargetingOptions.html |   20 +-
 .../dyn/displayvideo_v4.inventorySources.html |   12 +-
 docs/dyn/displayvideo_v4.partners.html        |    8 +-
 ...rgetingTypes.assignedTargetingOptions.html |   16 +-
 .../documents/displayvideo.v2.json            |  977 +---------------
 .../documents/displayvideo.v3.json            | 1015 ++---------------
 .../documents/displayvideo.v4.json            |  112 +-
 36 files changed, 1118 insertions(+), 2817 deletions(-)

diff --git a/docs/dyn/displayvideo_v2.advertisers.html b/docs/dyn/displayvideo_v2.advertisers.html
index a2f494af7b..2d764d21f2 100644
--- a/docs/dyn/displayvideo_v2.advertisers.html
+++ b/docs/dyn/displayvideo_v2.advertisers.html
@@ -362,7 +362,7 @@ 

Method Details

The object takes the form of: { # Request message for BulkEditAdvertiserAssignedTargetingOptions. - "createRequests": [ # The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE` + "createRequests": [ # The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` { # A request listing which assigned targeting options of a given targeting type should be created and added. "assignedTargetingOptions": [ # Required. The assigned targeting options to create and add. { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings. @@ -469,7 +469,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -509,7 +509,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -654,7 +654,7 @@

Method Details

"targetingType": "A String", # Required. Identifies the type of this assigned targeting option. }, ], - "deleteRequests": [ # The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE` + "deleteRequests": [ # The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` { # A request listing which assigned targeting options of a given targeting type should be deleted. "assignedTargetingOptionIds": [ # Required. The assigned targeting option IDs to delete. "A String", @@ -778,7 +778,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -818,7 +818,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -1238,7 +1238,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1278,7 +1278,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. diff --git a/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html index b7351a30c2..1922bab3ce 100644 --- a/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html +++ b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html @@ -114,10 +114,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -213,10 +213,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -339,10 +339,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -451,10 +451,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -570,10 +570,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -670,10 +670,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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 56f345d625..3e5e3568b2 100644 --- a/docs/dyn/displayvideo_v2.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.html @@ -233,7 +233,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -273,7 +273,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -586,7 +586,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -626,7 +626,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -805,10 +805,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -827,7 +827,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -842,14 +842,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -857,7 +857,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -895,7 +895,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -916,6 +916,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -933,11 +934,11 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -961,7 +962,7 @@

Method Details

"includeYoutubeVideos": True or False, # Whether to target inventory of channels and videos on YouTube and YouTube videos embedded on other sites. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], @@ -1074,10 +1075,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1096,7 +1097,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1111,14 +1112,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -1126,7 +1127,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1164,7 +1165,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1185,6 +1186,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -1202,11 +1204,11 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -1230,7 +1232,7 @@

Method Details

"includeYoutubeVideos": True or False, # Whether to target inventory of channels and videos on YouTube and YouTube videos embedded on other sites. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], @@ -1303,10 +1305,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1325,7 +1327,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1340,14 +1342,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -1355,7 +1357,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1393,7 +1395,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1414,6 +1416,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -1431,11 +1434,11 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -1459,7 +1462,7 @@

Method Details

"includeYoutubeVideos": True or False, # Whether to target inventory of channels and videos on YouTube and YouTube videos embedded on other sites. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], @@ -1587,10 +1590,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1609,7 +1612,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1624,14 +1627,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -1639,7 +1642,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1677,7 +1680,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1698,6 +1701,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -1715,11 +1719,11 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -1743,7 +1747,7 @@

Method Details

"includeYoutubeVideos": True or False, # Whether to target inventory of channels and videos on YouTube and YouTube videos embedded on other sites. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], @@ -1829,10 +1833,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1851,7 +1855,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1866,14 +1870,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -1881,7 +1885,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1919,7 +1923,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1940,6 +1944,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -1957,11 +1962,11 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -1985,7 +1990,7 @@

Method Details

"includeYoutubeVideos": True or False, # Whether to target inventory of channels and videos on YouTube and YouTube videos embedded on other sites. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], @@ -2078,10 +2083,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -2100,7 +2105,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -2115,14 +2120,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -2130,7 +2135,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2168,7 +2173,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -2189,6 +2194,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -2206,11 +2212,11 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -2234,7 +2240,7 @@

Method Details

"includeYoutubeVideos": True or False, # Whether to target inventory of channels and videos on YouTube and YouTube videos embedded on other sites. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], @@ -2308,10 +2314,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -2330,7 +2336,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -2345,14 +2351,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -2360,7 +2366,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2398,7 +2404,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -2419,6 +2425,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -2436,11 +2443,11 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -2464,7 +2471,7 @@

Method Details

"includeYoutubeVideos": True or False, # Whether to target inventory of channels and videos on YouTube and YouTube videos embedded on other sites. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], diff --git a/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html index 8047395645..71233bc797 100644 --- a/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html @@ -263,7 +263,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -303,7 +303,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -557,7 +557,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -597,7 +597,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -818,7 +818,7 @@

Method Details

Args: advertiserId: string, Required. The ID of the advertiser the line item belongs to. (required) lineItemId: string, Required. The ID of the line item the assigned targeting option belongs to. (required) - targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_INVENTORY_MODE` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) (required) + targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) (required) Allowed values TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version. TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps). @@ -982,7 +982,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1022,7 +1022,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -1172,7 +1172,7 @@

Method Details

Args: advertiserId: string, Required. The ID of the advertiser the line item belongs to. (required) lineItemId: string, Required. The ID of the line item to list assigned targeting options for. (required) - targetingType: string, Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_INVENTORY_MODE` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) (required) + targetingType: string, Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) (required) Allowed values TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version. TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps). @@ -1341,7 +1341,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1381,7 +1381,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. diff --git a/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html index 1f4dab5aa6..8b9155f3bd 100644 --- a/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.targetingTypes.assignedTargetingOptions.html @@ -104,7 +104,7 @@

Method Details

Args: advertiserId: string, Required. The ID of the advertiser. (required) - targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE` (required) + targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` (required) Allowed values TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version. TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps). @@ -262,7 +262,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -302,7 +302,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -556,7 +556,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -596,7 +596,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -745,7 +745,7 @@

Method Details

Args: advertiserId: string, Required. The ID of the advertiser. (required) - targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE` (required) + targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` (required) Allowed values TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version. TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps). @@ -979,7 +979,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1019,7 +1019,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -1337,7 +1337,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1377,7 +1377,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. diff --git a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroupAds.html b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroupAds.html index 13709bd549..b41611695a 100644 --- a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroupAds.html +++ b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroupAds.html @@ -124,7 +124,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "bumperAd": { # Details for a bumper ad. # Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. @@ -146,7 +146,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, }, @@ -174,10 +174,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -191,7 +191,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], "description": "A String", # The description of the ad. @@ -200,7 +200,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video used by the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead. }, @@ -224,10 +224,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -239,7 +239,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video the ad promotes. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "videoPerformanceAd": { # Details for a video performance ad. # Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. @@ -257,7 +257,7 @@

Method Details

"mimeType": "A String", # Output only. MIME type of the image asset. }, ], - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # The list of descriptions shown on the call-to-action banner. @@ -270,7 +270,7 @@

Method Details

"headlines": [ # The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner. + "longHeadlines": [ # The list of long headlines shown on the call-to-action banner. "A String", ], "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. @@ -278,7 +278,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -323,7 +323,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "bumperAd": { # Details for a bumper ad. # Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. @@ -345,7 +345,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, }, @@ -373,10 +373,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -390,7 +390,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], "description": "A String", # The description of the ad. @@ -399,7 +399,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video used by the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead. }, @@ -423,10 +423,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -438,7 +438,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video the ad promotes. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "videoPerformanceAd": { # Details for a video performance ad. # Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. @@ -456,7 +456,7 @@

Method Details

"mimeType": "A String", # Output only. MIME type of the image asset. }, ], - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # The list of descriptions shown on the call-to-action banner. @@ -469,7 +469,7 @@

Method Details

"headlines": [ # The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner. + "longHeadlines": [ # The list of long headlines shown on the call-to-action banner. "A String", ], "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. @@ -477,7 +477,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, diff --git a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html index cf9540093a..068fd41c29 100644 --- a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html +++ b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html @@ -225,7 +225,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -265,7 +265,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -474,7 +474,7 @@

Method Details

"productMatchType": "A String", # How products are selected by the product feed. }, "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [targeting expansion](https://support.google.com/displayvideo/answer/10191558) settings of the ad group. This config is only applicable when eligible audience list targeting is assigned to the ad group. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -533,7 +533,7 @@

Method Details

"productMatchType": "A String", # How products are selected by the product feed. }, "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [targeting expansion](https://support.google.com/displayvideo/answer/10191558) settings of the ad group. This config is only applicable when eligible audience list targeting is assigned to the ad group. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, diff --git a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html index b69f1750d1..b3ff3bd34f 100644 --- a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions.html @@ -263,7 +263,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -303,7 +303,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -622,7 +622,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -662,7 +662,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. diff --git a/docs/dyn/displayvideo_v2.html b/docs/dyn/displayvideo_v2.html index 74f9e92a6b..998ed54666 100644 --- a/docs/dyn/displayvideo_v2.html +++ b/docs/dyn/displayvideo_v2.html @@ -114,11 +114,6 @@

Instance Methods

Returns the inventorySourceGroups Resource.

-

- inventorySources() -

-

Returns the inventorySources Resource.

-

media()

diff --git a/docs/dyn/displayvideo_v2.partners.html b/docs/dyn/displayvideo_v2.partners.html index 678d5348d5..71a8cc0443 100644 --- a/docs/dyn/displayvideo_v2.partners.html +++ b/docs/dyn/displayvideo_v2.partners.html @@ -222,7 +222,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -262,7 +262,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -531,7 +531,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -571,7 +571,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. diff --git a/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html index ef6b6a1ed6..78b176b301 100644 --- a/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v2.partners.targetingTypes.assignedTargetingOptions.html @@ -262,7 +262,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -302,7 +302,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -556,7 +556,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -596,7 +596,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -979,7 +979,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1019,7 +1019,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -1337,7 +1337,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1377,7 +1377,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html index f9aaba6982..2fb3800930 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html @@ -79,10 +79,10 @@

Instance Methods

Close httplib2 connections.

create(advertiserId, body=None, x__xgafv=None)

-

Creates an ad group ad.

+

Creates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.

delete(advertiserId, adGroupAdId, x__xgafv=None)

-

Deletes an ad group ad.

+

Deletes an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.

get(advertiserId, adGroupAdId, x__xgafv=None)

Gets an ad group ad.

@@ -94,7 +94,7 @@

Instance Methods

Retrieves the next page of results.

patch(advertiserId, adGroupAdId, body=None, updateMask=None, x__xgafv=None)

-

Updates an ad group ad.

+

Updates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.

Method Details

close() @@ -103,7 +103,7 @@

Method Details

create(advertiserId, body=None, x__xgafv=None) -
Creates an ad group ad.
+  
Creates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
 
 Args:
   advertiserId: string, Output only. The unique ID of the advertiser the ad belongs to. (required)
@@ -260,7 +260,7 @@ 

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "bumperAd": { # Details for a bumper ad. # 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. @@ -282,7 +282,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, }, @@ -291,11 +291,11 @@

Method Details

"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). + "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). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. - "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less. + "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card. "headline": "A String", # Required. The headline of the card. @@ -328,7 +328,7 @@

Method Details

}, }, ], - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -347,10 +347,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -409,10 +409,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -433,7 +433,7 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. @@ -445,7 +445,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -468,7 +468,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "longHeadlines": [ # Required. The list of lone headlines shown on the ad. + "longHeadlines": [ # Required. The list of long headlines shown on the ad. "A String", ], "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. @@ -477,7 +477,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -505,10 +505,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -522,7 +522,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], "description": "A String", # The description of the ad. @@ -531,7 +531,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video used by the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead. }, @@ -555,10 +555,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -570,7 +570,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video the ad promotes. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. @@ -588,7 +588,7 @@

Method Details

"mimeType": "A String", # Output only. MIME type of the image asset. }, ], - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # The list of descriptions shown on the call-to-action banner. @@ -601,7 +601,7 @@

Method Details

"headlines": [ # The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner. + "longHeadlines": [ # The list of long headlines shown on the call-to-action banner. "A String", ], "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. @@ -609,7 +609,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -773,7 +773,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "bumperAd": { # Details for a bumper ad. # 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. @@ -795,7 +795,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, }, @@ -804,11 +804,11 @@

Method Details

"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). + "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). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. - "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less. + "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card. "headline": "A String", # Required. The headline of the card. @@ -841,7 +841,7 @@

Method Details

}, }, ], - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -860,10 +860,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -922,10 +922,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -946,7 +946,7 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. @@ -958,7 +958,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -981,7 +981,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "longHeadlines": [ # Required. The list of lone headlines shown on the ad. + "longHeadlines": [ # Required. The list of long headlines shown on the ad. "A String", ], "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. @@ -990,7 +990,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -1018,10 +1018,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -1035,7 +1035,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], "description": "A String", # The description of the ad. @@ -1044,7 +1044,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video used by the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead. }, @@ -1068,10 +1068,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -1083,7 +1083,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video the ad promotes. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. @@ -1101,7 +1101,7 @@

Method Details

"mimeType": "A String", # Output only. MIME type of the image asset. }, ], - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # The list of descriptions shown on the call-to-action banner. @@ -1114,7 +1114,7 @@

Method Details

"headlines": [ # The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner. + "longHeadlines": [ # The list of long headlines shown on the call-to-action banner. "A String", ], "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. @@ -1122,7 +1122,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -1131,11 +1131,11 @@

Method Details

delete(advertiserId, adGroupAdId, x__xgafv=None) -
Deletes an ad group ad.
+  
Deletes an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser the ad belongs to. (required)
-  adGroupAdId: string, Required. The ID of the ad to delete. (required)
+  adGroupAdId: string, Required. The ID of the ad to delete. Only Demand Gen ads are supported. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1313,7 +1313,7 @@ 

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "bumperAd": { # Details for a bumper ad. # 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. @@ -1335,7 +1335,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, }, @@ -1344,11 +1344,11 @@

Method Details

"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). + "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). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. - "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less. + "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card. "headline": "A String", # Required. The headline of the card. @@ -1381,7 +1381,7 @@

Method Details

}, }, ], - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -1400,10 +1400,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -1462,10 +1462,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -1486,7 +1486,7 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. @@ -1498,7 +1498,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -1521,7 +1521,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "longHeadlines": [ # Required. The list of lone headlines shown on the ad. + "longHeadlines": [ # Required. The list of long headlines shown on the ad. "A String", ], "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. @@ -1530,7 +1530,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -1558,10 +1558,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -1575,7 +1575,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], "description": "A String", # The description of the ad. @@ -1584,7 +1584,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video used by the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead. }, @@ -1608,10 +1608,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -1623,7 +1623,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video the ad promotes. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. @@ -1641,7 +1641,7 @@

Method Details

"mimeType": "A String", # Output only. MIME type of the image asset. }, ], - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # The list of descriptions shown on the call-to-action banner. @@ -1654,7 +1654,7 @@

Method Details

"headlines": [ # The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner. + "longHeadlines": [ # The list of long headlines shown on the call-to-action banner. "A String", ], "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. @@ -1662,7 +1662,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -1839,7 +1839,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "bumperAd": { # Details for a bumper ad. # 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. @@ -1861,7 +1861,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, }, @@ -1870,11 +1870,11 @@

Method Details

"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). + "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). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. - "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less. + "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card. "headline": "A String", # Required. The headline of the card. @@ -1907,7 +1907,7 @@

Method Details

}, }, ], - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -1926,10 +1926,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -1988,10 +1988,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -2012,7 +2012,7 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. @@ -2024,7 +2024,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -2047,7 +2047,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "longHeadlines": [ # Required. The list of lone headlines shown on the ad. + "longHeadlines": [ # Required. The list of long headlines shown on the ad. "A String", ], "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. @@ -2056,7 +2056,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -2084,10 +2084,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -2101,7 +2101,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], "description": "A String", # The description of the ad. @@ -2110,7 +2110,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video used by the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead. }, @@ -2134,10 +2134,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -2149,7 +2149,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video the ad promotes. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. @@ -2167,7 +2167,7 @@

Method Details

"mimeType": "A String", # Output only. MIME type of the image asset. }, ], - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # The list of descriptions shown on the call-to-action banner. @@ -2180,7 +2180,7 @@

Method Details

"headlines": [ # The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner. + "longHeadlines": [ # The list of long headlines shown on the call-to-action banner. "A String", ], "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. @@ -2188,7 +2188,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -2214,7 +2214,7 @@

Method Details

patch(advertiserId, adGroupAdId, body=None, updateMask=None, x__xgafv=None) -
Updates an ad group ad.
+  
Updates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
 
 Args:
   advertiserId: string, Output only. The unique ID of the advertiser the ad belongs to. (required)
@@ -2372,7 +2372,7 @@ 

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "bumperAd": { # Details for a bumper ad. # 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. @@ -2394,7 +2394,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, }, @@ -2403,11 +2403,11 @@

Method Details

"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). + "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). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. - "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less. + "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card. "headline": "A String", # Required. The headline of the card. @@ -2440,7 +2440,7 @@

Method Details

}, }, ], - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -2459,10 +2459,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -2521,10 +2521,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -2545,7 +2545,7 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. @@ -2557,7 +2557,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -2580,7 +2580,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "longHeadlines": [ # Required. The list of lone headlines shown on the ad. + "longHeadlines": [ # Required. The list of long headlines shown on the ad. "A String", ], "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. @@ -2589,7 +2589,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -2617,10 +2617,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -2634,7 +2634,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], "description": "A String", # The description of the ad. @@ -2643,7 +2643,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video used by the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead. }, @@ -2667,10 +2667,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -2682,7 +2682,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video the ad promotes. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. @@ -2700,7 +2700,7 @@

Method Details

"mimeType": "A String", # Output only. MIME type of the image asset. }, ], - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # The list of descriptions shown on the call-to-action banner. @@ -2713,7 +2713,7 @@

Method Details

"headlines": [ # The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner. + "longHeadlines": [ # The list of long headlines shown on the call-to-action banner. "A String", ], "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. @@ -2721,7 +2721,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -2886,7 +2886,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "bumperAd": { # Details for a bumper ad. # 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. @@ -2908,7 +2908,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, }, @@ -2917,11 +2917,11 @@

Method Details

"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). + "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). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. - "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less. + "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card. "headline": "A String", # Required. The headline of the card. @@ -2954,7 +2954,7 @@

Method Details

}, }, ], - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -2973,10 +2973,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -3035,10 +3035,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -3059,7 +3059,7 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. @@ -3071,7 +3071,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -3094,7 +3094,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "longHeadlines": [ # Required. The list of lone headlines shown on the ad. + "longHeadlines": [ # Required. The list of long headlines shown on the ad. "A String", ], "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. @@ -3103,7 +3103,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -3131,10 +3131,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -3148,7 +3148,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], "description": "A String", # The description of the ad. @@ -3157,7 +3157,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video used by the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead. }, @@ -3181,10 +3181,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -3196,7 +3196,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video the ad promotes. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. @@ -3214,7 +3214,7 @@

Method Details

"mimeType": "A String", # Output only. MIME type of the image asset. }, ], - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # The list of descriptions shown on the call-to-action banner. @@ -3227,7 +3227,7 @@

Method Details

"headlines": [ # The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner. + "longHeadlines": [ # The list of long headlines shown on the call-to-action banner. "A String", ], "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. @@ -3235,7 +3235,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroups.html b/docs/dyn/displayvideo_v3.advertisers.adGroups.html index cae6de54e2..3cff12ace2 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroups.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroups.html @@ -81,7 +81,7 @@

Instance Methods

bulkEditAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None)

-

Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.

+

Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.

bulkListAdGroupAssignedTargetingOptions(advertiserId, adGroupIds=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.

@@ -93,10 +93,10 @@

Instance Methods

Close httplib2 connections.

create(advertiserId, body=None, x__xgafv=None)

-

Creates a new ad group. Returns the newly created ad group if successful.

+

Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.

delete(advertiserId, adGroupId, x__xgafv=None)

-

Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist.

+

Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.

get(advertiserId, adGroupId, x__xgafv=None)

Gets an ad group.

@@ -108,11 +108,11 @@

Instance Methods

Retrieves the next page of results.

patch(advertiserId, adGroupId, body=None, updateMask=None, x__xgafv=None)

-

Updates an existing ad group. Returns the updated ad group if successful.

+

Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.

Method Details

bulkEditAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None) -
Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.
+  
Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser the ad groups belong to. (required)
@@ -253,7 +253,7 @@ 

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -293,7 +293,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -647,7 +647,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -687,7 +687,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -875,7 +875,7 @@

Method Details

create(advertiserId, body=None, x__xgafv=None) -
Creates a new ad group. Returns the newly created ad group if successful.
+  
Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
 
 Args:
   advertiserId: string, Output only. The unique ID of the advertiser the ad group belongs to. (required)
@@ -885,7 +885,7 @@ 

Method Details

{ # A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. - "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups. + "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. "adGroupInventoryStrategy": "A String", # The inventory strategy. "selectedInventories": { # The inventory control of the ad group. # The selected inventories. "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory. @@ -893,16 +893,16 @@

Method Details

"allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory. "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory. "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory. - "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream. + "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream inventory. }, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -947,7 +947,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, } @@ -962,7 +962,7 @@

Method Details

{ # A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. - "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups. + "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. "adGroupInventoryStrategy": "A String", # The inventory strategy. "selectedInventories": { # The inventory control of the ad group. # The selected inventories. "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory. @@ -970,16 +970,16 @@

Method Details

"allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory. "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory. "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory. - "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream. + "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream inventory. }, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1024,14 +1024,14 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, }
delete(advertiserId, adGroupId, x__xgafv=None) -
Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist.
+  
Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser this ad group belongs to. (required)
@@ -1066,7 +1066,7 @@ 

Method Details

{ # A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. - "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups. + "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. "adGroupInventoryStrategy": "A String", # The inventory strategy. "selectedInventories": { # The inventory control of the ad group. # The selected inventories. "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory. @@ -1074,16 +1074,16 @@

Method Details

"allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory. "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory. "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory. - "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream. + "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream inventory. }, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1128,7 +1128,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, }
@@ -1156,7 +1156,7 @@

Method Details

{ # A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. - "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups. + "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. "adGroupInventoryStrategy": "A String", # The inventory strategy. "selectedInventories": { # The inventory control of the ad group. # The selected inventories. "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory. @@ -1164,16 +1164,16 @@

Method Details

"allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory. "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory. "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory. - "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream. + "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream inventory. }, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1218,7 +1218,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, }, ], @@ -1242,7 +1242,7 @@

Method Details

patch(advertiserId, adGroupId, body=None, updateMask=None, x__xgafv=None) -
Updates an existing ad group. Returns the updated ad group if successful.
+  
Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
 
 Args:
   advertiserId: string, Output only. The unique ID of the advertiser the ad group belongs to. (required)
@@ -1253,7 +1253,7 @@ 

Method Details

{ # A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. - "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups. + "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. "adGroupInventoryStrategy": "A String", # The inventory strategy. "selectedInventories": { # The inventory control of the ad group. # The selected inventories. "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory. @@ -1261,16 +1261,16 @@

Method Details

"allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory. "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory. "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory. - "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream. + "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream inventory. }, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1315,7 +1315,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, } @@ -1331,7 +1331,7 @@

Method Details

{ # A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. - "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups. + "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. "adGroupInventoryStrategy": "A String", # The inventory strategy. "selectedInventories": { # The inventory control of the ad group. # The selected inventories. "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory. @@ -1339,16 +1339,16 @@

Method Details

"allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory. "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory. "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory. - "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream. + "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream inventory. }, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1393,7 +1393,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, }
diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html index 10b694f49c..2fa3bc9ad9 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html @@ -79,10 +79,10 @@

Instance Methods

Close httplib2 connections.

create(advertiserId, adGroupId, targetingType, body=None, x__xgafv=None)

-

Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.

+

Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.

delete(advertiserId, adGroupId, targetingType, assignedTargetingOptionId, x__xgafv=None)

-

Deletes an assigned targeting option from an ad group. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.

+

Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.

get(advertiserId, adGroupId, targetingType, assignedTargetingOptionId, x__xgafv=None)

Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.

@@ -100,7 +100,7 @@

Method Details

create(advertiserId, adGroupId, targetingType, body=None, x__xgafv=None) -
Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.
+  
Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser the ad group belongs to. (required)
@@ -287,7 +287,7 @@ 

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -327,7 +327,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -624,7 +624,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -664,7 +664,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -829,7 +829,7 @@

Method Details

delete(advertiserId, adGroupId, targetingType, assignedTargetingOptionId, x__xgafv=None) -
Deletes an assigned targeting option from an ad group. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.
+  
Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser the ad group belongs to. (required)
@@ -1094,7 +1094,7 @@ 

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1134,7 +1134,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -1497,7 +1497,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1537,7 +1537,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. diff --git a/docs/dyn/displayvideo_v3.advertisers.html b/docs/dyn/displayvideo_v3.advertisers.html index bf5521d888..8d0701e484 100644 --- a/docs/dyn/displayvideo_v3.advertisers.html +++ b/docs/dyn/displayvideo_v3.advertisers.html @@ -363,7 +363,7 @@

Method Details

The object takes the form of: { # Request message for BulkEditAdvertiserAssignedTargetingOptions. - "createRequests": [ # The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE` + "createRequests": [ # The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` { # A request listing which assigned targeting options of a given targeting type should be created and added. "assignedTargetingOptions": [ # Required. The assigned targeting options to create and add. { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings. @@ -493,7 +493,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -533,7 +533,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -698,7 +698,7 @@

Method Details

"targetingType": "A String", # Required. Identifies the type of this assigned targeting option. }, ], - "deleteRequests": [ # The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE` + "deleteRequests": [ # The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` { # A request listing which assigned targeting options of a given targeting type should be deleted. "assignedTargetingOptionIds": [ # Required. The assigned targeting option IDs to delete. "A String", @@ -845,7 +845,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -885,7 +885,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -1354,7 +1354,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1394,7 +1394,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. diff --git a/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html index 75bbbf9415..69b210cad2 100644 --- a/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html +++ b/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html @@ -114,10 +114,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -220,10 +220,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -353,10 +353,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -472,10 +472,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -598,10 +598,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -705,10 +705,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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 6d64cf522f..5bfaeb56e9 100644 --- a/docs/dyn/displayvideo_v3.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v3.advertisers.lineItems.html @@ -256,7 +256,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -296,7 +296,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -652,7 +652,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -692,7 +692,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -891,10 +891,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -919,7 +919,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -934,14 +934,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -949,7 +949,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -987,7 +987,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1008,6 +1008,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -1025,14 +1026,14 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1047,7 +1048,7 @@

Method Details

"includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], @@ -1063,7 +1064,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1160,10 +1161,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1188,7 +1189,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1203,14 +1204,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -1218,7 +1219,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1256,7 +1257,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1277,6 +1278,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -1294,14 +1296,14 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1316,7 +1318,7 @@

Method Details

"includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], @@ -1332,7 +1334,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1389,10 +1391,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1417,7 +1419,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1432,14 +1434,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -1447,7 +1449,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1485,7 +1487,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1506,6 +1508,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -1523,14 +1526,14 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1545,7 +1548,7 @@

Method Details

"includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], @@ -1561,7 +1564,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1673,10 +1676,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1701,7 +1704,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1716,14 +1719,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -1731,7 +1734,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1769,7 +1772,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1790,6 +1793,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -1807,14 +1811,14 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1829,7 +1833,7 @@

Method Details

"includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], @@ -1845,7 +1849,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1915,10 +1919,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1943,7 +1947,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1958,14 +1962,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -1973,7 +1977,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2011,7 +2015,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -2032,6 +2036,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -2049,14 +2054,14 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2071,7 +2076,7 @@

Method Details

"includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], @@ -2087,7 +2092,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2164,10 +2169,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -2192,7 +2197,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -2207,14 +2212,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -2222,7 +2227,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2260,7 +2265,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -2281,6 +2286,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -2298,14 +2304,14 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2320,7 +2326,7 @@

Method Details

"includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], @@ -2336,7 +2342,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2394,10 +2400,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -2422,7 +2428,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -2437,14 +2443,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -2452,7 +2458,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2490,7 +2496,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -2511,6 +2517,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -2528,14 +2535,14 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2550,7 +2557,7 @@

Method Details

"includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], @@ -2566,7 +2573,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. diff --git a/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html index 8ad52cd941..3d9bdea423 100644 --- a/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html @@ -287,7 +287,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -327,7 +327,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -624,7 +624,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -664,7 +664,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -906,7 +906,7 @@

Method Details

Args: advertiserId: string, Required. The ID of the advertiser the line item belongs to. (required) lineItemId: string, Required. The ID of the line item the assigned targeting option belongs to. (required) - targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_INVENTORY_MODE` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) (required) + targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) (required) Allowed values TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version. TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps). @@ -1094,7 +1094,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1134,7 +1134,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -1304,7 +1304,7 @@

Method Details

Args: advertiserId: string, Required. The ID of the advertiser the line item belongs to. (required) lineItemId: string, Required. The ID of the line item to list assigned targeting options for. (required) - targetingType: string, Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_INVENTORY_MODE` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) (required) + targetingType: string, Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) (required) Allowed values TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version. TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps). @@ -1497,7 +1497,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1537,7 +1537,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. diff --git a/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html index 01f4608762..4f69320268 100644 --- a/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.targetingTypes.assignedTargetingOptions.html @@ -104,7 +104,7 @@

Method Details

Args: advertiserId: string, Required. The ID of the advertiser. (required) - targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE` (required) + targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` (required) Allowed values TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version. TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps). @@ -286,7 +286,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -326,7 +326,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -623,7 +623,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -663,7 +663,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -832,7 +832,7 @@

Method Details

Args: advertiserId: string, Required. The ID of the advertiser. (required) - targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE` (required) + targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` (required) Allowed values TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version. TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps). @@ -1091,7 +1091,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1131,7 +1131,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -1493,7 +1493,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1533,7 +1533,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. diff --git a/docs/dyn/displayvideo_v3.html b/docs/dyn/displayvideo_v3.html index 0edb11c17b..52ef8513e3 100644 --- a/docs/dyn/displayvideo_v3.html +++ b/docs/dyn/displayvideo_v3.html @@ -119,11 +119,6 @@

Instance Methods

Returns the inventorySourceGroups Resource.

-

- inventorySources() -

-

Returns the inventorySources Resource.

-

media()

diff --git a/docs/dyn/displayvideo_v3.partners.html b/docs/dyn/displayvideo_v3.partners.html index a0c6f16d22..f13f047e6e 100644 --- a/docs/dyn/displayvideo_v3.partners.html +++ b/docs/dyn/displayvideo_v3.partners.html @@ -245,7 +245,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -285,7 +285,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -597,7 +597,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -637,7 +637,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. diff --git a/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html index 0275e81212..99d19aca4a 100644 --- a/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.partners.targetingTypes.assignedTargetingOptions.html @@ -286,7 +286,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -326,7 +326,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -623,7 +623,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -663,7 +663,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -1091,7 +1091,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1131,7 +1131,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -1493,7 +1493,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1533,7 +1533,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html index ec6c64ac2f..1e77d5ee70 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html @@ -79,10 +79,10 @@

Instance Methods

Close httplib2 connections.

create(advertiserId, body=None, x__xgafv=None)

-

Creates an ad group ad.

+

Creates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.

delete(advertiserId, adGroupAdId, x__xgafv=None)

-

Deletes an ad group ad.

+

Deletes an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.

get(advertiserId, adGroupAdId, x__xgafv=None)

Gets an ad group ad.

@@ -94,7 +94,7 @@

Instance Methods

Retrieves the next page of results.

patch(advertiserId, adGroupAdId, body=None, updateMask=None, x__xgafv=None)

-

Updates an ad group ad.

+

Updates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.

Method Details

close() @@ -103,7 +103,7 @@

Method Details

create(advertiserId, body=None, x__xgafv=None) -
Creates an ad group ad.
+  
Creates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
 
 Args:
   advertiserId: string, Output only. The unique ID of the advertiser the ad belongs to. (required)
@@ -260,7 +260,7 @@ 

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "bumperAd": { # Details for a bumper ad. # 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. @@ -282,7 +282,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, }, @@ -291,11 +291,11 @@

Method Details

"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). + "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). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. - "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less. + "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card. "headline": "A String", # Required. The headline of the card. @@ -328,7 +328,7 @@

Method Details

}, }, ], - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -347,10 +347,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -409,10 +409,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -433,7 +433,7 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. @@ -445,7 +445,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -468,7 +468,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "longHeadlines": [ # Required. The list of lone headlines shown on the ad. + "longHeadlines": [ # Required. The list of long headlines shown on the ad. "A String", ], "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. @@ -477,7 +477,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -505,10 +505,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -522,7 +522,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], "description": "A String", # The description of the ad. @@ -531,7 +531,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video used by the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead. }, @@ -555,10 +555,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -570,7 +570,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video the ad promotes. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. @@ -588,7 +588,7 @@

Method Details

"mimeType": "A String", # Output only. MIME type of the image asset. }, ], - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # The list of descriptions shown on the call-to-action banner. @@ -601,7 +601,7 @@

Method Details

"headlines": [ # The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner. + "longHeadlines": [ # The list of long headlines shown on the call-to-action banner. "A String", ], "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. @@ -609,7 +609,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -773,7 +773,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "bumperAd": { # Details for a bumper ad. # 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. @@ -795,7 +795,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, }, @@ -804,11 +804,11 @@

Method Details

"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). + "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). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. - "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less. + "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card. "headline": "A String", # Required. The headline of the card. @@ -841,7 +841,7 @@

Method Details

}, }, ], - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -860,10 +860,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -922,10 +922,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -946,7 +946,7 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. @@ -958,7 +958,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -981,7 +981,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "longHeadlines": [ # Required. The list of lone headlines shown on the ad. + "longHeadlines": [ # Required. The list of long headlines shown on the ad. "A String", ], "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. @@ -990,7 +990,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -1018,10 +1018,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -1035,7 +1035,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], "description": "A String", # The description of the ad. @@ -1044,7 +1044,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video used by the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead. }, @@ -1068,10 +1068,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -1083,7 +1083,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video the ad promotes. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. @@ -1101,7 +1101,7 @@

Method Details

"mimeType": "A String", # Output only. MIME type of the image asset. }, ], - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # The list of descriptions shown on the call-to-action banner. @@ -1114,7 +1114,7 @@

Method Details

"headlines": [ # The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner. + "longHeadlines": [ # The list of long headlines shown on the call-to-action banner. "A String", ], "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. @@ -1122,7 +1122,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -1131,11 +1131,11 @@

Method Details

delete(advertiserId, adGroupAdId, x__xgafv=None) -
Deletes an ad group ad.
+  
Deletes an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser the ad belongs to. (required)
-  adGroupAdId: string, Required. The ID of the ad to delete. (required)
+  adGroupAdId: string, Required. The ID of the ad to delete. Only Demand Gen ads are supported. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1313,7 +1313,7 @@ 

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "bumperAd": { # Details for a bumper ad. # 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. @@ -1335,7 +1335,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, }, @@ -1344,11 +1344,11 @@

Method Details

"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). + "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). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. - "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less. + "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card. "headline": "A String", # Required. The headline of the card. @@ -1381,7 +1381,7 @@

Method Details

}, }, ], - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -1400,10 +1400,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -1462,10 +1462,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -1486,7 +1486,7 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. @@ -1498,7 +1498,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -1521,7 +1521,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "longHeadlines": [ # Required. The list of lone headlines shown on the ad. + "longHeadlines": [ # Required. The list of long headlines shown on the ad. "A String", ], "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. @@ -1530,7 +1530,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -1558,10 +1558,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -1575,7 +1575,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], "description": "A String", # The description of the ad. @@ -1584,7 +1584,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video used by the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead. }, @@ -1608,10 +1608,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -1623,7 +1623,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video the ad promotes. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. @@ -1641,7 +1641,7 @@

Method Details

"mimeType": "A String", # Output only. MIME type of the image asset. }, ], - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # The list of descriptions shown on the call-to-action banner. @@ -1654,7 +1654,7 @@

Method Details

"headlines": [ # The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner. + "longHeadlines": [ # The list of long headlines shown on the call-to-action banner. "A String", ], "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. @@ -1662,7 +1662,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -1839,7 +1839,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "bumperAd": { # Details for a bumper ad. # 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. @@ -1861,7 +1861,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, }, @@ -1870,11 +1870,11 @@

Method Details

"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). + "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). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. - "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less. + "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card. "headline": "A String", # Required. The headline of the card. @@ -1907,7 +1907,7 @@

Method Details

}, }, ], - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -1926,10 +1926,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -1988,10 +1988,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -2012,7 +2012,7 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. @@ -2024,7 +2024,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -2047,7 +2047,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "longHeadlines": [ # Required. The list of lone headlines shown on the ad. + "longHeadlines": [ # Required. The list of long headlines shown on the ad. "A String", ], "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. @@ -2056,7 +2056,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -2084,10 +2084,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -2101,7 +2101,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], "description": "A String", # The description of the ad. @@ -2110,7 +2110,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video used by the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead. }, @@ -2134,10 +2134,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -2149,7 +2149,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video the ad promotes. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. @@ -2167,7 +2167,7 @@

Method Details

"mimeType": "A String", # Output only. MIME type of the image asset. }, ], - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # The list of descriptions shown on the call-to-action banner. @@ -2180,7 +2180,7 @@

Method Details

"headlines": [ # The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner. + "longHeadlines": [ # The list of long headlines shown on the call-to-action banner. "A String", ], "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. @@ -2188,7 +2188,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -2214,7 +2214,7 @@

Method Details

patch(advertiserId, adGroupAdId, body=None, updateMask=None, x__xgafv=None) -
Updates an ad group ad.
+  
Updates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
 
 Args:
   advertiserId: string, Output only. The unique ID of the advertiser the ad belongs to. (required)
@@ -2372,7 +2372,7 @@ 

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "bumperAd": { # Details for a bumper ad. # 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. @@ -2394,7 +2394,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, }, @@ -2403,11 +2403,11 @@

Method Details

"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). + "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). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. - "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less. + "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card. "headline": "A String", # Required. The headline of the card. @@ -2440,7 +2440,7 @@

Method Details

}, }, ], - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -2459,10 +2459,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -2521,10 +2521,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -2545,7 +2545,7 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. @@ -2557,7 +2557,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -2580,7 +2580,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "longHeadlines": [ # Required. The list of lone headlines shown on the ad. + "longHeadlines": [ # Required. The list of long headlines shown on the ad. "A String", ], "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. @@ -2589,7 +2589,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -2617,10 +2617,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -2634,7 +2634,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], "description": "A String", # The description of the ad. @@ -2643,7 +2643,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video used by the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead. }, @@ -2667,10 +2667,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -2682,7 +2682,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video the ad promotes. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. @@ -2700,7 +2700,7 @@

Method Details

"mimeType": "A String", # Output only. MIME type of the image asset. }, ], - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # The list of descriptions shown on the call-to-action banner. @@ -2713,7 +2713,7 @@

Method Details

"headlines": [ # The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner. + "longHeadlines": [ # The list of long headlines shown on the call-to-action banner. "A String", ], "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. @@ -2721,7 +2721,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -2886,7 +2886,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "bumperAd": { # Details for a bumper ad. # 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. @@ -2908,7 +2908,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, }, @@ -2917,11 +2917,11 @@

Method Details

"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). + "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). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. - "callToAction": "A String", # Required. The call-to-action button shown on the card. Must use 10 characters or less. + "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. "finalMobileUrl": "A String", # Optional. The URL address of the webpage that people reach after they click the card on a mobile device. "finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the card. "headline": "A String", # Required. The headline of the card. @@ -2954,7 +2954,7 @@

Method Details

}, }, ], - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -2973,10 +2973,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -3035,10 +3035,10 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "description": "A String", # Required. The description of the ad. @@ -3059,7 +3059,7 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "businessName": "A String", # Required. The business name shown on the ad. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. @@ -3071,7 +3071,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "customParameters": { # Optional. The custom parameters to pass custom values to tracking URL template. + "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # Required. The list of descriptions shown on the ad. @@ -3094,7 +3094,7 @@

Method Details

}, "mimeType": "A String", # Output only. MIME type of the image asset. }, - "longHeadlines": [ # Required. The list of lone headlines shown on the ad. + "longHeadlines": [ # Required. The list of long headlines shown on the ad. "A String", ], "trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. @@ -3103,7 +3103,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, @@ -3131,10 +3131,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -3148,7 +3148,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], "description": "A String", # The description of the ad. @@ -3157,7 +3157,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video used by the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, "videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead. }, @@ -3181,10 +3181,10 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video of the ad. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, }, @@ -3196,7 +3196,7 @@

Method Details

"video": { # Details of a YouTube video. # The YouTube video the ad promotes. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, }, "videoPerformanceAd": { # Details for a video performance ad. # Output only. Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. @@ -3214,7 +3214,7 @@

Method Details

"mimeType": "A String", # Output only. MIME type of the image asset. }, ], - "customParameters": { # The custom parameters to pass custom values to tracking URL template. + "customParameters": { # The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", }, "descriptions": [ # The list of descriptions shown on the call-to-action banner. @@ -3227,7 +3227,7 @@

Method Details

"headlines": [ # The list of headlines shown on the call-to-action banner. "A String", ], - "longHeadlines": [ # The list of lone headlines shown on the call-to-action banner. + "longHeadlines": [ # The list of long headlines shown on the call-to-action banner. "A String", ], "trackingUrl": "A String", # The URL address loaded in the background for tracking purposes. @@ -3235,7 +3235,7 @@

Method Details

{ # Details of a YouTube video. "id": "A String", # Output only. The YouTube video ID which can be searched on YouTube webpage. "unavailableReason": "A String", # The reason why the video data is not available. - "videoAssetId": "A String", # Required. The YouTube video asset id. This is ad_asset.ad_asset_id. + "videoAssetId": "A String", # Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource. }, ], }, diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroups.html b/docs/dyn/displayvideo_v4.advertisers.adGroups.html index bf4a289068..696552a975 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroups.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroups.html @@ -86,7 +86,7 @@

Instance Methods

bulkEditAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None)

-

Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.

+

Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.

bulkListAssignedTargetingOptions(advertiserId, adGroupIds=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.

@@ -98,10 +98,10 @@

Instance Methods

Close httplib2 connections.

create(advertiserId, body=None, x__xgafv=None)

-

Creates a new ad group. Returns the newly created ad group if successful.

+

Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.

delete(advertiserId, adGroupId, x__xgafv=None)

-

Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist.

+

Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.

get(advertiserId, adGroupId, x__xgafv=None)

Gets an ad group.

@@ -113,11 +113,11 @@

Instance Methods

Retrieves the next page of results.

patch(advertiserId, adGroupId, body=None, updateMask=None, x__xgafv=None)

-

Updates an existing ad group. Returns the updated ad group if successful.

+

Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.

Method Details

bulkEditAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None) -
Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.
+  
Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser the ad groups belong to. (required)
@@ -258,7 +258,7 @@ 

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -298,7 +298,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -652,7 +652,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -692,7 +692,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -880,7 +880,7 @@

Method Details

create(advertiserId, body=None, x__xgafv=None) -
Creates a new ad group. Returns the newly created ad group if successful.
+  
Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
 
 Args:
   advertiserId: string, Output only. The unique ID of the advertiser the ad group belongs to. (required)
@@ -890,7 +890,7 @@ 

Method Details

{ # A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. - "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups. + "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. "adGroupInventoryStrategy": "A String", # The inventory strategy. "selectedInventories": { # The inventory control of the ad group. # The selected inventories. "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory. @@ -898,16 +898,16 @@

Method Details

"allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory. "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory. "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory. - "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream. + "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream inventory. }, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -952,7 +952,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, } @@ -967,7 +967,7 @@

Method Details

{ # A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. - "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups. + "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. "adGroupInventoryStrategy": "A String", # The inventory strategy. "selectedInventories": { # The inventory control of the ad group. # The selected inventories. "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory. @@ -975,16 +975,16 @@

Method Details

"allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory. "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory. "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory. - "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream. + "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream inventory. }, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1029,14 +1029,14 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, }
delete(advertiserId, adGroupId, x__xgafv=None) -
Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist.
+  
Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser this ad group belongs to. (required)
@@ -1071,7 +1071,7 @@ 

Method Details

{ # A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. - "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups. + "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. "adGroupInventoryStrategy": "A String", # The inventory strategy. "selectedInventories": { # The inventory control of the ad group. # The selected inventories. "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory. @@ -1079,16 +1079,16 @@

Method Details

"allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory. "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory. "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory. - "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream. + "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream inventory. }, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1133,7 +1133,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, }
@@ -1161,7 +1161,7 @@

Method Details

{ # A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. - "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups. + "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. "adGroupInventoryStrategy": "A String", # The inventory strategy. "selectedInventories": { # The inventory control of the ad group. # The selected inventories. "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory. @@ -1169,16 +1169,16 @@

Method Details

"allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory. "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory. "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory. - "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream. + "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream inventory. }, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1223,7 +1223,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, }, ], @@ -1247,7 +1247,7 @@

Method Details

patch(advertiserId, adGroupId, body=None, updateMask=None, x__xgafv=None) -
Updates an existing ad group. Returns the updated ad group if successful.
+  
Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
 
 Args:
   advertiserId: string, Output only. The unique ID of the advertiser the ad group belongs to. (required)
@@ -1258,7 +1258,7 @@ 

Method Details

{ # A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. - "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups. + "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. "adGroupInventoryStrategy": "A String", # The inventory strategy. "selectedInventories": { # The inventory control of the ad group. # The selected inventories. "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory. @@ -1266,16 +1266,16 @@

Method Details

"allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory. "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory. "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory. - "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream. + "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream inventory. }, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1320,7 +1320,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, } @@ -1336,7 +1336,7 @@

Method Details

{ # A single ad group associated with a line item. "adGroupFormat": "A String", # Required. Immutable. The format of the ads in the ad group. "adGroupId": "A String", # Output only. The unique ID of the ad group. Assigned by the system. - "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups. + "adGroupInventoryControl": { # The inventory control of the ad group. # Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group. "adGroupInventoryStrategy": "A String", # The inventory strategy. "selectedInventories": { # The inventory control of the ad group. # The selected inventories. "allowDiscover": True or False, # Whether the ad group is opted-in to Discover inventory. @@ -1344,16 +1344,16 @@

Method Details

"allowGoogleDisplayNetwork": True or False, # Whether the ad group is opted-in to Google Display Network inventory. "allowYoutubeFeed": True or False, # Whether the ad group is opted-in to YouTube in-feed inventory. "allowYoutubeShorts": True or False, # Whether the ad group is opted-in to YouTube shorts inventory. - "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream. + "allowYoutubeStream": True or False, # Whether the ad group is opted-in to YouTube in-stream inventory. }, }, "advertiserId": "A String", # Output only. The unique ID of the advertiser the ad group belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy used by the ad group. Only the youtubeAndPartnersBid and demandGenBid field can be used in the bidding strategy. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1398,7 +1398,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, }
diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html index 07fdeacafc..32f847a599 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html @@ -79,10 +79,10 @@

Instance Methods

Close httplib2 connections.

create(advertiserId, adGroupId, targetingType, body=None, x__xgafv=None)

-

Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.

+

Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.

delete(advertiserId, adGroupId, targetingType, assignedTargetingOptionId, x__xgafv=None)

-

Deletes an assigned targeting option from an ad group. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.

+

Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.

get(advertiserId, adGroupId, targetingType, assignedTargetingOptionId, x__xgafv=None)

Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.

@@ -100,7 +100,7 @@

Method Details

create(advertiserId, adGroupId, targetingType, body=None, x__xgafv=None) -
Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.
+  
Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser the ad group belongs to. (required)
@@ -287,7 +287,7 @@ 

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -327,7 +327,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -624,7 +624,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -664,7 +664,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -829,7 +829,7 @@

Method Details

delete(advertiserId, adGroupId, targetingType, assignedTargetingOptionId, x__xgafv=None) -
Deletes an assigned targeting option from an ad group. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.
+  
Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser the ad group belongs to. (required)
@@ -1094,7 +1094,7 @@ 

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1134,7 +1134,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -1497,7 +1497,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1537,7 +1537,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. diff --git a/docs/dyn/displayvideo_v4.advertisers.html b/docs/dyn/displayvideo_v4.advertisers.html index 7629236d79..d4bb9e03f3 100644 --- a/docs/dyn/displayvideo_v4.advertisers.html +++ b/docs/dyn/displayvideo_v4.advertisers.html @@ -368,7 +368,7 @@

Method Details

The object takes the form of: { # Request message for BulkEditAdvertiserAssignedTargetingOptions. - "createRequests": [ # The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE` + "createRequests": [ # The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` { # A request listing which assigned targeting options of a given targeting type should be created and added. "assignedTargetingOptions": [ # Required. The assigned targeting options to create and add. { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings. @@ -498,7 +498,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -538,7 +538,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -703,7 +703,7 @@

Method Details

"targetingType": "A String", # Required. Identifies the type of this assigned targeting option. }, ], - "deleteRequests": [ # The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE` + "deleteRequests": [ # The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` { # A request listing which assigned targeting options of a given targeting type should be deleted. "assignedTargetingOptionIds": [ # Required. The assigned targeting option IDs to delete. "A String", @@ -850,7 +850,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -890,7 +890,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -1359,7 +1359,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1399,7 +1399,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. diff --git a/docs/dyn/displayvideo_v4.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v4.advertisers.insertionOrders.html index 13f7039e3f..d8a3b2a6eb 100644 --- a/docs/dyn/displayvideo_v4.advertisers.insertionOrders.html +++ b/docs/dyn/displayvideo_v4.advertisers.insertionOrders.html @@ -114,10 +114,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -220,10 +220,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -353,10 +353,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -472,10 +472,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -598,10 +598,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -705,10 +705,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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 b387cdddbc..eeeced61d9 100644 --- a/docs/dyn/displayvideo_v4.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v4.advertisers.lineItems.html @@ -261,7 +261,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -301,7 +301,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -657,7 +657,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -697,7 +697,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -896,10 +896,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -924,7 +924,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -939,14 +939,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -954,7 +954,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -992,7 +992,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1013,6 +1013,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -1030,14 +1031,14 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1052,7 +1053,7 @@

Method Details

"includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], @@ -1068,7 +1069,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1165,10 +1166,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1193,7 +1194,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1208,14 +1209,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -1223,7 +1224,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1261,7 +1262,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1282,6 +1283,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -1299,14 +1301,14 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1321,7 +1323,7 @@

Method Details

"includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], @@ -1337,7 +1339,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1394,10 +1396,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1422,7 +1424,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1437,14 +1439,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -1452,7 +1454,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1490,7 +1492,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1511,6 +1513,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -1528,14 +1531,14 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1550,7 +1553,7 @@

Method Details

"includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], @@ -1566,7 +1569,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1678,10 +1681,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1706,7 +1709,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1721,14 +1724,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -1736,7 +1739,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1774,7 +1777,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -1795,6 +1798,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -1812,14 +1816,14 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1834,7 +1838,7 @@

Method Details

"includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], @@ -1850,7 +1854,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1920,10 +1924,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -1948,7 +1952,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -1963,14 +1967,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -1978,7 +1982,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2016,7 +2020,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -2037,6 +2041,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -2054,14 +2059,14 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2076,7 +2081,7 @@

Method Details

"includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], @@ -2092,7 +2097,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2169,10 +2174,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -2197,7 +2202,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -2212,14 +2217,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -2227,7 +2232,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2265,7 +2270,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -2286,6 +2291,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -2303,14 +2309,14 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2325,7 +2331,7 @@

Method Details

"includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], @@ -2341,7 +2347,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2399,10 +2405,10 @@

Method Details

"advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to. "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item. "demandGenBid": { # Settings that control the bid strategy for Demand Gen resources. # A bid strategy used by Demand Gen resources. It can only be used for a Demand Gen line item or ad group entity. - "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. + "effectiveBiddingValue": "A String", # Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. "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_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. + "type": "A String", # Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. + "value": "A String", # Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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. @@ -2427,7 +2433,7 @@

Method Details

}, }, "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item. - "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types. + "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items. "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. }, @@ -2442,14 +2448,14 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. - "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` { # Settings that control how third-party measurement vendors are configured. @@ -2457,7 +2463,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2495,7 +2501,7 @@

Method Details

}, "flightDateType": "A String", # Required. The type of the line item's flight dates. }, - "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN. + "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`. @@ -2516,6 +2522,7 @@

Method Details

"publisher": "A String", # Output only. The app publisher. }, "name": "A String", # Output only. The resource name of the line item. + "optimizeFixedBidding": True or False, # Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`. "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item. "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. @@ -2533,14 +2540,14 @@

Method Details

], "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item. "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). - "markupType": "A String", # Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`. + "markupType": "A String", # Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items. }, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2555,7 +2562,7 @@

Method Details

"includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube. }, "leadFormId": "A String", # Optional. The ID of the form to generate leads. - "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed. + "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. "A String", ], @@ -2571,7 +2578,7 @@

Method Details

"vendor": "A String", # The third-party measurement vendor. }, ], - "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR` + "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. diff --git a/docs/dyn/displayvideo_v4.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v4.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html index 90401e34d2..81c0119580 100644 --- a/docs/dyn/displayvideo_v4.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v4.advertisers.lineItems.targetingTypes.assignedTargetingOptions.html @@ -287,7 +287,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -327,7 +327,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -624,7 +624,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -664,7 +664,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -906,7 +906,7 @@

Method Details

Args: advertiserId: string, Required. The ID of the advertiser the line item belongs to. (required) lineItemId: string, Required. The ID of the line item the assigned targeting option belongs to. (required) - targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_INVENTORY_MODE` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) (required) + targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) (required) Allowed values TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version. TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps). @@ -1094,7 +1094,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1134,7 +1134,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -1304,7 +1304,7 @@

Method Details

Args: advertiserId: string, Required. The ID of the advertiser the line item belongs to. (required) lineItemId: string, Required. The ID of the line item to list assigned targeting options for. (required) - targetingType: string, Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_INVENTORY_MODE` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) (required) + targetingType: string, Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) (required) Allowed values TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version. TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps). @@ -1497,7 +1497,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1537,7 +1537,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. diff --git a/docs/dyn/displayvideo_v4.advertisers.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v4.advertisers.targetingTypes.assignedTargetingOptions.html index 166274d299..79e343c24e 100644 --- a/docs/dyn/displayvideo_v4.advertisers.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v4.advertisers.targetingTypes.assignedTargetingOptions.html @@ -104,7 +104,7 @@

Method Details

Args: advertiserId: string, Required. The ID of the advertiser. (required) - targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE` (required) + targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` (required) Allowed values TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version. TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps). @@ -286,7 +286,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -326,7 +326,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -623,7 +623,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -663,7 +663,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -832,7 +832,7 @@

Method Details

Args: advertiserId: string, Required. The ID of the advertiser. (required) - targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE` (required) + targetingType: string, Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` (required) Allowed values TARGETING_TYPE_UNSPECIFIED - Default value when type is not specified or is unknown in this version. TARGETING_TYPE_CHANNEL - Target a channel (a custom group of related websites or apps). @@ -1091,7 +1091,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1131,7 +1131,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -1493,7 +1493,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1533,7 +1533,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. diff --git a/docs/dyn/displayvideo_v4.inventorySources.html b/docs/dyn/displayvideo_v4.inventorySources.html index 01dd1f4b53..850b7f64e0 100644 --- a/docs/dyn/displayvideo_v4.inventorySources.html +++ b/docs/dyn/displayvideo_v4.inventorySources.html @@ -109,7 +109,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # An inventory source. Next ID: 22 +{ # An inventory source. "commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery. "creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages. { # Creative requirements configuration for the inventory source. @@ -189,7 +189,7 @@

Method Details

Returns: An object of the form: - { # An inventory source. Next ID: 22 + { # An inventory source. "commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery. "creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages. { # Creative requirements configuration for the inventory source. @@ -318,7 +318,7 @@

Method Details

Returns: An object of the form: - { # An inventory source. Next ID: 22 + { # An inventory source. "commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery. "creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages. { # Creative requirements configuration for the inventory source. @@ -410,7 +410,7 @@

Method Details

{ "inventorySources": [ # The list of inventory sources. This list will be absent if empty. - { # An inventory source. Next ID: 22 + { # An inventory source. "commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery. "creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages. { # Creative requirements configuration for the inventory source. @@ -507,7 +507,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # An inventory source. Next ID: 22 +{ # An inventory source. "commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery. "creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages. { # Creative requirements configuration for the inventory source. @@ -588,7 +588,7 @@

Method Details

Returns: An object of the form: - { # An inventory source. Next ID: 22 + { # An inventory source. "commitment": "A String", # Whether the inventory source has a guaranteed or non-guaranteed delivery. "creativeConfigs": [ # The creative requirements of the inventory source. Not applicable for auction packages. { # Creative requirements configuration for the inventory source. diff --git a/docs/dyn/displayvideo_v4.partners.html b/docs/dyn/displayvideo_v4.partners.html index 0c934dcaa5..99050c2e06 100644 --- a/docs/dyn/displayvideo_v4.partners.html +++ b/docs/dyn/displayvideo_v4.partners.html @@ -245,7 +245,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -285,7 +285,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -597,7 +597,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -637,7 +637,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. diff --git a/docs/dyn/displayvideo_v4.partners.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v4.partners.targetingTypes.assignedTargetingOptions.html index 21072353bf..02fb581ed1 100644 --- a/docs/dyn/displayvideo_v4.partners.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v4.partners.targetingTypes.assignedTargetingOptions.html @@ -286,7 +286,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -326,7 +326,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -623,7 +623,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -663,7 +663,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -1091,7 +1091,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1131,7 +1131,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. @@ -1493,7 +1493,7 @@

Method Details

"dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting. "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). - "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER. + "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`. }, "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. "displayName": "A String", # Output only. The display name of the device make and model. @@ -1533,7 +1533,7 @@

Method Details

"inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. }, "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned. - "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted. + "exemptedPolicyNames": [ # Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users. "A String", ], "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v2.json b/googleapiclient/discovery_cache/documents/displayvideo.v2.json index fd0a99d31f..6f2481f2e0 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v2.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v2.json @@ -2200,7 +2200,7 @@ "type": "string" }, "targetingType": { -"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_INVENTORY_MODE` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)", +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_CHANNEL", @@ -2366,7 +2366,7 @@ "type": "string" }, "targetingType": { -"description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_INVENTORY_MODE` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)", +"description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_CHANNEL", @@ -3478,7 +3478,7 @@ "type": "string" }, "targetingType": { -"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE`", +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_CHANNEL", @@ -3625,7 +3625,7 @@ "type": "string" }, "targetingType": { -"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE`", +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_CHANNEL", @@ -5949,198 +5949,6 @@ } } }, -"inventorySources": { -"methods": { -"create": { -"description": "Creates a new inventory source. Returns the newly created inventory source if successful.", -"flatPath": "v2/inventorySources", -"httpMethod": "POST", -"id": "displayvideo.inventorySources.create", -"parameterOrder": [], -"parameters": { -"advertiserId": { -"description": "The ID of the advertiser that the request is being made within.", -"format": "int64", -"location": "query", -"type": "string" -}, -"partnerId": { -"description": "The ID of the partner that the request is being made within.", -"format": "int64", -"location": "query", -"type": "string" -} -}, -"path": "v2/inventorySources", -"request": { -"$ref": "InventorySource" -}, -"response": { -"$ref": "InventorySource" -}, -"scopes": [ -"https://www.googleapis.com/auth/display-video" -] -}, -"editInventorySourceReadWriteAccessors": { -"description": "Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.", -"flatPath": "v2/inventorySources/{inventorySourcesId}:editInventorySourceReadWriteAccessors", -"httpMethod": "POST", -"id": "displayvideo.inventorySources.editInventorySourceReadWriteAccessors", -"parameterOrder": [ -"inventorySourceId" -], -"parameters": { -"inventorySourceId": { -"description": "Required. The ID of inventory source to update.", -"format": "int64", -"location": "path", -"pattern": "^[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v2/inventorySources/{+inventorySourceId}:editInventorySourceReadWriteAccessors", -"request": { -"$ref": "EditInventorySourceReadWriteAccessorsRequest" -}, -"response": { -"$ref": "InventorySourceAccessors" -}, -"scopes": [ -"https://www.googleapis.com/auth/display-video" -] -}, -"get": { -"description": "Gets an inventory source.", -"flatPath": "v2/inventorySources/{inventorySourcesId}", -"httpMethod": "GET", -"id": "displayvideo.inventorySources.get", -"parameterOrder": [ -"inventorySourceId" -], -"parameters": { -"inventorySourceId": { -"description": "Required. The ID of the inventory source to fetch.", -"format": "int64", -"location": "path", -"pattern": "^[^/]+$", -"required": true, -"type": "string" -}, -"partnerId": { -"description": "Required. The ID of the DV360 partner to which the fetched inventory source is permissioned.", -"format": "int64", -"location": "query", -"type": "string" -} -}, -"path": "v2/inventorySources/{+inventorySourceId}", -"response": { -"$ref": "InventorySource" -}, -"scopes": [ -"https://www.googleapis.com/auth/display-video" -] -}, -"list": { -"description": "Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.", -"flatPath": "v2/inventorySources", -"httpMethod": "GET", -"id": "displayvideo.inventorySources.list", -"parameterOrder": [], -"parameters": { -"advertiserId": { -"description": "The ID of the advertiser that has access to the inventory source.", -"format": "int64", -"location": "query", -"type": "string" -}, -"filter": { -"description": "Allows filtering by inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `status.entityStatus` * `commitment` * `deliveryMethod` * `rateDetails.rateType` * `exchange` Examples: * All active inventory sources: `status.entityStatus=\"ENTITY_STATUS_ACTIVE\"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange=\"EXCHANGE_GOOGLE_AD_MANAGER\" OR exchange=\"EXCHANGE_RUBICON\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned.", -"location": "query", -"type": "string" -}, -"partnerId": { -"description": "The ID of the partner that has access to the inventory source.", -"format": "int64", -"location": "query", -"type": "string" -} -}, -"path": "v2/inventorySources", -"response": { -"$ref": "ListInventorySourcesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/display-video" -] -}, -"patch": { -"description": "Updates an existing inventory source. Returns the updated inventory source if successful.", -"flatPath": "v2/inventorySources/{inventorySourcesId}", -"httpMethod": "PATCH", -"id": "displayvideo.inventorySources.patch", -"parameterOrder": [ -"inventorySourceId" -], -"parameters": { -"advertiserId": { -"description": "The ID of the advertiser that the request is being made within.", -"format": "int64", -"location": "query", -"type": "string" -}, -"inventorySourceId": { -"description": "Output only. The unique ID of the inventory source. Assigned by the system.", -"format": "int64", -"location": "path", -"pattern": "^[^/]+$", -"required": true, -"type": "string" -}, -"partnerId": { -"description": "The ID of the partner that the request is being made within.", -"format": "int64", -"location": "query", -"type": "string" -}, -"updateMask": { -"description": "Required. The mask to control which fields to update.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -} -}, -"path": "v2/inventorySources/{+inventorySourceId}", -"request": { -"$ref": "InventorySource" -}, -"response": { -"$ref": "InventorySource" -}, -"scopes": [ -"https://www.googleapis.com/auth/display-video" -] -} -} -}, "media": { "methods": { "download": { @@ -7981,7 +7789,7 @@ } } }, -"revision": "20260331", +"revision": "20260412", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -9366,14 +9174,14 @@ "id": "BulkEditAdvertiserAssignedTargetingOptionsRequest", "properties": { "createRequests": { -"description": "The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE`", +"description": "The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`", "items": { "$ref": "CreateAssignedTargetingOptionsRequest" }, "type": "array" }, "deleteRequests": { -"description": "The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE`", +"description": "The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`", "items": { "$ref": "DeleteAssignedTargetingOptionsRequest" }, @@ -10741,7 +10549,7 @@ "type": "string" }, "primaryAttributionModelId": { -"description": "Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items.", +"description": "Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.", "format": "int64", "type": "string" } @@ -11361,61 +11169,6 @@ false }, "type": "object" }, -"CreativeConfig": { -"description": "Creative requirements configuration for the inventory source.", -"id": "CreativeConfig", -"properties": { -"creativeType": { -"description": "The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`", -"enum": [ -"CREATIVE_TYPE_UNSPECIFIED", -"CREATIVE_TYPE_STANDARD", -"CREATIVE_TYPE_EXPANDABLE", -"CREATIVE_TYPE_VIDEO", -"CREATIVE_TYPE_NATIVE", -"CREATIVE_TYPE_TEMPLATED_APP_INSTALL", -"CREATIVE_TYPE_NATIVE_SITE_SQUARE", -"CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL", -"CREATIVE_TYPE_LIGHTBOX", -"CREATIVE_TYPE_NATIVE_APP_INSTALL", -"CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE", -"CREATIVE_TYPE_AUDIO", -"CREATIVE_TYPE_PUBLISHER_HOSTED", -"CREATIVE_TYPE_NATIVE_VIDEO", -"CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO", -"CREATIVE_TYPE_ASSET_BASED_CREATIVE" -], -"enumDescriptions": [ -"Type value is not specified or is unknown in this version.", -"Standard display creative. Create and update methods are supported for this creative type if the hosting_source is one of the following: * `HOSTING_SOURCE_HOSTED` * `HOSTING_SOURCE_THIRD_PARTY`", -"Expandable creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_THIRD_PARTY`", -"Video creative. Create and update methods are supported for this creative type if the hosting_source is one of the following: * `HOSTING_SOURCE_HOSTED` * `HOSTING_SOURCE_THIRD_PARTY`", -"Native creative rendered by publishers with assets from advertiser. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", -"Templated app install mobile creative (banner). Create and update methods are **not** supported for this creative type.", -"Square native creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", -"Interstitial creative including both display and video. Create and update methods are **not** supported for this creative type.", -"Responsive and expandable Lightbox creative. Create and update methods are **not** supported for this creative type.", -"Native app install creative. Create and update methods are **not** supported for this creative type.", -"Square native app install creative. Create and update methods are **not** supported for this creative type.", -"Audio creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", -"Publisher hosted creative. Create and update methods are **not** supported for this creative type.", -"Native video creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", -"Templated app install mobile video creative. Create and update methods are **not** supported for this creative type.", -"Asset-based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." -], -"type": "string" -}, -"displayCreativeConfig": { -"$ref": "InventorySourceDisplayCreativeConfig", -"description": "The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`." -}, -"videoCreativeConfig": { -"$ref": "InventorySourceVideoCreativeConfig", -"description": "The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`." -} -}, -"type": "object" -}, "CustomBiddingAlgorithm": { "description": "A single custom bidding algorithm.", "id": "CustomBiddingAlgorithm", @@ -11774,7 +11527,7 @@ false "type": "integer" }, "timeZoneResolution": { -"description": "Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER.", +"description": "Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`.", "enum": [ "TIME_ZONE_RESOLUTION_UNSPECIFIED", "TIME_ZONE_RESOLUTION_END_USER", @@ -11921,7 +11674,7 @@ false "id": "DemandGenBiddingStrategy", "properties": { "effectiveBiddingValue": { -"description": "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.", +"description": "Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0.", "format": "int64", "readOnly": true, "type": "string" @@ -11942,14 +11695,15 @@ false "type": "string" }, "type": { -"description": "Optional. The type of the bidding strategy. This can only be set at the line item level.", +"description": "Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item.", "enum": [ "DEMAND_GEN_BIDDING_STRATEGY_TYPE_UNSPECIFIED", "DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA", "DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS", "DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS", "DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE", -"DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CLICKS" +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CLICKS", +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC" ], "enumDescriptions": [ "Type is not specified or unknown.", @@ -11957,12 +11711,13 @@ false "A bidding strategy that automatically maximizes revenue while averaging a specific target Return On Ad Spend (ROAS).", "A bidding strategy that automatically maximizes number of conversions", "A bidding strategy that automatically maximizes revenue while spending your budget.", -"A bidding strategy that automatically maximizes clicks within a given budget." +"A bidding strategy that automatically maximizes clicks within a given budget.", +"A bidding strategy that automatically optimizes cost per click." ], "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_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.", +"description": "Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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" } @@ -11974,11 +11729,11 @@ false "id": "DemandGenSettings", "properties": { "geoLanguageTargetingEnabled": { -"description": "Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups.", +"description": "Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups.", "type": "boolean" }, "linkedMerchantId": { -"description": "Optional. The ID of the merchant which is linked to the line item for product feed.", +"description": "Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser.", "format": "int64", "type": "string" }, @@ -12602,49 +12357,6 @@ false }, "type": "object" }, -"EditInventorySourceReadWriteAccessorsRequest": { -"description": "Request message for InventorySourceService.EditInventorySourceReadWriteAccessors.", -"id": "EditInventorySourceReadWriteAccessorsRequest", -"properties": { -"advertisersUpdate": { -"$ref": "EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate", -"description": "The advertisers to add or remove from the list of advertisers that have read/write access to the inventory source. This change will remove an existing partner read/write accessor." -}, -"assignPartner": { -"description": "Set the partner context as read/write accessor of the inventory source. This will remove all other current read/write advertiser accessors.", -"type": "boolean" -}, -"partnerId": { -"description": "Required. The partner context by which the accessors change is being made.", -"format": "int64", -"type": "string" -} -}, -"type": "object" -}, -"EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate": { -"description": "Update to the list of advertisers with read/write access to the inventory source.", -"id": "EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate", -"properties": { -"addedAdvertisers": { -"description": "The advertisers to add.", -"items": { -"format": "int64", -"type": "string" -}, -"type": "array" -}, -"removedAdvertisers": { -"description": "The advertisers to remove.", -"items": { -"format": "int64", -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -14554,7 +14266,7 @@ false "additionalProperties": { "type": "string" }, -"description": "The custom parameters to pass custom values to tracking URL template.", +"description": "The custom parameters and accompanying values to add to the tracking URL.", "type": "object" } }, @@ -14998,430 +14710,39 @@ true }, "type": "object" }, -"InventorySource": { -"description": "An inventory source. Next ID: 22", -"id": "InventorySource", +"InventorySourceAssignedTargetingOptionDetails": { +"description": "Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.", +"id": "InventorySourceAssignedTargetingOptionDetails", "properties": { -"commitment": { -"description": "Whether the inventory source has a guaranteed or non-guaranteed delivery.", -"enum": [ -"INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED", -"INVENTORY_SOURCE_COMMITMENT_GUARANTEED", -"INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED" -], -"enumDescriptions": [ -"The commitment is not specified or is unknown in this version.", -"The commitment is guaranteed delivery.", -"The commitment is non-guaranteed delivery." -], +"inventorySourceId": { +"description": "Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.", +"format": "int64", "type": "string" +} +}, +"type": "object" }, -"creativeConfigs": { -"description": "The creative requirements of the inventory source. Not applicable for auction packages.", +"InventorySourceFilter": { +"description": "A filtering option for filtering on Inventory Source entities.", +"id": "InventorySourceFilter", +"properties": { +"inventorySourceIds": { +"description": "Inventory Sources to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Leave empty to download all Inventory Sources for the selected Advertiser or Partner.", "items": { -"$ref": "CreativeConfig" +"format": "int64", +"type": "string" }, "type": "array" +} }, -"dealId": { -"description": "The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.", -"type": "string" -}, -"deliveryMethod": { -"description": "The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.", -"enum": [ -"INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED", -"INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC", -"INVENTORY_SOURCE_DELIVERY_METHOD_TAG" -], -"enumDescriptions": [ -"The delivery method is not specified or is unknown in this version.", -"The delivery method is programmatic.", -"The delivery method is tag." -], -"type": "string" -}, -"displayName": { -"description": "The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.", -"type": "string" -}, -"exchange": { -"description": "The exchange to which the inventory source belongs.", -"enum": [ -"EXCHANGE_UNSPECIFIED", -"EXCHANGE_GOOGLE_AD_MANAGER", -"EXCHANGE_APPNEXUS", -"EXCHANGE_BRIGHTROLL", -"EXCHANGE_ADFORM", -"EXCHANGE_ADMETA", -"EXCHANGE_ADMIXER", -"EXCHANGE_ADSMOGO", -"EXCHANGE_ADSWIZZ", -"EXCHANGE_BIDSWITCH", -"EXCHANGE_BRIGHTROLL_DISPLAY", -"EXCHANGE_CADREON", -"EXCHANGE_DAILYMOTION", -"EXCHANGE_FIVE", -"EXCHANGE_FLUCT", -"EXCHANGE_FREEWHEEL", -"EXCHANGE_GENIEE", -"EXCHANGE_GUMGUM", -"EXCHANGE_IMOBILE", -"EXCHANGE_IBILLBOARD", -"EXCHANGE_IMPROVE_DIGITAL", -"EXCHANGE_INDEX", -"EXCHANGE_KARGO", -"EXCHANGE_MICROAD", -"EXCHANGE_MOPUB", -"EXCHANGE_NEND", -"EXCHANGE_ONE_BY_AOL_DISPLAY", -"EXCHANGE_ONE_BY_AOL_MOBILE", -"EXCHANGE_ONE_BY_AOL_VIDEO", -"EXCHANGE_OOYALA", -"EXCHANGE_OPENX", -"EXCHANGE_PERMODO", -"EXCHANGE_PLATFORMONE", -"EXCHANGE_PLATFORMID", -"EXCHANGE_PUBMATIC", -"EXCHANGE_PULSEPOINT", -"EXCHANGE_REVENUEMAX", -"EXCHANGE_RUBICON", -"EXCHANGE_SMARTCLIP", -"EXCHANGE_SMARTRTB", -"EXCHANGE_SMARTSTREAMTV", -"EXCHANGE_SOVRN", -"EXCHANGE_SPOTXCHANGE", -"EXCHANGE_STROER", -"EXCHANGE_TEADSTV", -"EXCHANGE_TELARIA", -"EXCHANGE_TVN", -"EXCHANGE_UNITED", -"EXCHANGE_YIELDLAB", -"EXCHANGE_YIELDMO", -"EXCHANGE_UNRULYX", -"EXCHANGE_OPEN8", -"EXCHANGE_TRITON", -"EXCHANGE_TRIPLELIFT", -"EXCHANGE_TABOOLA", -"EXCHANGE_INMOBI", -"EXCHANGE_SMAATO", -"EXCHANGE_AJA", -"EXCHANGE_SUPERSHIP", -"EXCHANGE_NEXSTAR_DIGITAL", -"EXCHANGE_WAZE", -"EXCHANGE_SOUNDCAST", -"EXCHANGE_SHARETHROUGH", -"EXCHANGE_FYBER", -"EXCHANGE_RED_FOR_PUBLISHERS", -"EXCHANGE_MEDIANET", -"EXCHANGE_TAPJOY", -"EXCHANGE_VISTAR", -"EXCHANGE_DAX", -"EXCHANGE_JCD", -"EXCHANGE_PLACE_EXCHANGE", -"EXCHANGE_APPLOVIN", -"EXCHANGE_CONNATIX", -"EXCHANGE_RESET_DIGITAL", -"EXCHANGE_HIVESTACK", -"EXCHANGE_DRAX", -"EXCHANGE_APPLOVIN_GBID", -"EXCHANGE_FYBER_GBID", -"EXCHANGE_UNITY_GBID", -"EXCHANGE_CHARTBOOST_GBID", -"EXCHANGE_ADMOST_GBID", -"EXCHANGE_TOPON_GBID", -"EXCHANGE_NETFLIX", -"EXCHANGE_CORE", -"EXCHANGE_COMMERCE_GRID", -"EXCHANGE_SPOTIFY", -"EXCHANGE_TUBI", -"EXCHANGE_SNAP", -"EXCHANGE_CADENT" -], -"enumDescriptions": [ -"Exchange is not specified or is unknown in this version.", -"Google Ad Manager.", -"AppNexus.", -"BrightRoll Exchange for Video from Yahoo!.", -"Adform.", -"Admeta.", -"Admixer.", -"AdsMogo.", -"AdsWizz.", -"BidSwitch.", -"BrightRoll Exchange for Display from Yahoo!.", -"Cadreon.", -"Dailymotion.", -"Five.", -"Fluct.", -"FreeWheel SSP.", -"Geniee.", -"GumGum.", -"i-mobile.", -"iBILLBOARD.", -"Improve Digital.", -"Index Exchange.", -"Kargo.", -"MicroAd.", -"MoPub.", -"Nend.", -"ONE by AOL: Display Market Place.", -"ONE by AOL: Mobile.", -"ONE by AOL: Video.", -"Ooyala.", -"OpenX.", -"Permodo.", -"Platform One.", -"PlatformId.", -"PubMatic.", -"PulsePoint.", -"RevenueMax.", -"Rubicon.", -"SmartClip.", -"SmartRTB+.", -"SmartstreamTv.", -"Sovrn.", -"SpotXchange.", -"Str\u00f6er SSP.", -"TeadsTv.", -"Telaria.", -"TVN.", -"United.", -"Yieldlab.", -"Yieldmo.", -"UnrulyX.", -"Open8.", -"Triton.", -"TripleLift.", -"Taboola.", -"InMobi.", -"Smaato.", -"Aja.", -"Supership.", -"Nexstar Digital.", -"Waze.", -"SoundCast.", -"Sharethrough.", -"Fyber.", -"Red For Publishers.", -"Media.net.", -"Tapjoy.", -"Vistar.", -"DAX.", -"JCD.", -"Place Exchange.", -"AppLovin.", -"Connatix.", -"Reset Digital.", -"Hivestack.", -"Drax.", -"AppLovin MAX.", -"DT Fairbid.", -"Unity LevelPlay.", -"Chartboost Mediation.", -"AdMost.", -"TopOn.", -"Netflix.", -"Core.", -"Commerce Grid.", -"Spotify.", -"Tubi.", -"Snap.", -"Cadent." -], -"type": "string" -}, -"guaranteedOrderId": { -"description": "Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.", -"type": "string" -}, -"inventorySourceId": { -"description": "Output only. The unique ID of the inventory source. Assigned by the system.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"inventorySourceProductType": { -"description": "Output only. The product type of the inventory source, denoting the way through which it sells inventory.", -"enum": [ -"INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED", -"PREFERRED_DEAL", -"PRIVATE_AUCTION", -"PROGRAMMATIC_GUARANTEED", -"TAG_GUARANTEED", -"YOUTUBE_RESERVE", -"INSTANT_RESERVE", -"GUARANTEED_PACKAGE", -"PROGRAMMATIC_TV", -"AUCTION_PACKAGE" -], -"enumDescriptions": [ -"The product type is not specified or is unknown in this version. Modifying inventory sources of this product type are not supported via API.", -"The inventory source sells inventory through Preferred Deal.", -"The inventory source sells inventory through Private Auction.", -"The inventory source sells inventory through Programmatic Guaranteed.", -"The inventory source sells inventory through Tag Guaranteed.", -"The inventory source sells inventory through YouTube Reserve.", -"The inventory source sells inventory through Instant Reserve. Modifying inventory sources of this product type are not supported via API.", -"The inventory source sells inventory through Guaranteed Package. Modifying inventory sources of this product type are not supported via API.", -"The inventory source sells inventory through Programmtic TV. Modifying inventory sources of this product type are not supported via API.", -"The inventory source sells inventory through Auction Package. Modifying inventory sources of this product type are not supported via API." -], -"readOnly": true, -"type": "string" -}, -"inventorySourceType": { -"description": "Denotes the type of the inventory source.", -"enum": [ -"INVENTORY_SOURCE_TYPE_UNSPECIFIED", -"INVENTORY_SOURCE_TYPE_PRIVATE", -"INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE" -], -"enumDescriptions": [ -"The inventory source type is not specified or is unknown in this version.", -"Private inventory source.", -"Auction package." -], -"type": "string" -}, -"name": { -"description": "Output only. The resource name of the inventory source.", -"readOnly": true, -"type": "string" -}, -"publisherName": { -"description": "The publisher/seller name of the inventory source.", -"type": "string" -}, -"rateDetails": { -"$ref": "RateDetails", -"description": "Required. The rate details of the inventory source." -}, -"readAdvertiserIds": { -"description": "Output only. The IDs of advertisers with read-only access to the inventory source.", -"items": { -"format": "int64", -"type": "string" -}, -"readOnly": true, -"type": "array" -}, -"readPartnerIds": { -"description": "Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.", -"items": { -"format": "int64", -"type": "string" -}, -"readOnly": true, -"type": "array" -}, -"readWriteAccessors": { -"$ref": "InventorySourceAccessors", -"description": "The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids." -}, -"status": { -"$ref": "InventorySourceStatus", -"description": "The status settings of the inventory source." -}, -"timeRange": { -"$ref": "TimeRange", -"description": "The time range when this inventory source starts and stops serving." -}, -"updateTime": { -"description": "Output only. The timestamp when the inventory source was last updated. Assigned by the system.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"InventorySourceAccessors": { -"description": "The partner or advertisers with access to the inventory source.", -"id": "InventorySourceAccessors", -"properties": { -"advertisers": { -"$ref": "InventorySourceAccessorsAdvertiserAccessors", -"description": "The advertisers with access to the inventory source. All advertisers must belong to the same partner." -}, -"partner": { -"$ref": "InventorySourceAccessorsPartnerAccessor", -"description": "The partner with access to the inventory source." -} -}, -"type": "object" -}, -"InventorySourceAccessorsAdvertiserAccessors": { -"description": "The advertisers with access to the inventory source.", -"id": "InventorySourceAccessorsAdvertiserAccessors", -"properties": { -"advertiserIds": { -"description": "The IDs of the advertisers.", -"items": { -"format": "int64", -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"InventorySourceAccessorsPartnerAccessor": { -"description": "The partner with access to the inventory source.", -"id": "InventorySourceAccessorsPartnerAccessor", -"properties": { -"partnerId": { -"description": "The ID of the partner.", -"format": "int64", -"type": "string" -} -}, -"type": "object" -}, -"InventorySourceAssignedTargetingOptionDetails": { -"description": "Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.", -"id": "InventorySourceAssignedTargetingOptionDetails", -"properties": { -"inventorySourceId": { -"description": "Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.", -"format": "int64", -"type": "string" -} -}, -"type": "object" -}, -"InventorySourceDisplayCreativeConfig": { -"description": "The configuration for display creatives.", -"id": "InventorySourceDisplayCreativeConfig", -"properties": { -"creativeSize": { -"$ref": "Dimensions", -"description": "The size requirements for display creatives that can be assigned to the inventory source." -} -}, -"type": "object" -}, -"InventorySourceFilter": { -"description": "A filtering option for filtering on Inventory Source entities.", -"id": "InventorySourceFilter", -"properties": { -"inventorySourceIds": { -"description": "Inventory Sources to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Leave empty to download all Inventory Sources for the selected Advertiser or Partner.", -"items": { -"format": "int64", -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"InventorySourceGroup": { -"description": "A collection of targetable inventory sources.", -"id": "InventorySourceGroup", -"properties": { -"displayName": { -"description": "Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.", +"type": "object" +}, +"InventorySourceGroup": { +"description": "A collection of targetable inventory sources.", +"id": "InventorySourceGroup", +"properties": { +"displayName": { +"description": "Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.", "type": "string" }, "inventorySourceGroupId": { @@ -15450,90 +14771,6 @@ true }, "type": "object" }, -"InventorySourceStatus": { -"description": "The status related settings of the inventory source.", -"id": "InventorySourceStatus", -"properties": { -"configStatus": { -"description": "Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.", -"enum": [ -"INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED", -"INVENTORY_SOURCE_CONFIG_STATUS_PENDING", -"INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED" -], -"enumDescriptions": [ -"The approval status is not specified or is unknown in this version.", -"The beginning state of a guaranteed inventory source. The inventory source in this state needs to be configured.", -"The state after the buyer configures a guaranteed inventory source." -], -"readOnly": true, -"type": "string" -}, -"entityPauseReason": { -"description": "The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.", -"type": "string" -}, -"entityStatus": { -"description": "Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.", -"enum": [ -"ENTITY_STATUS_UNSPECIFIED", -"ENTITY_STATUS_ACTIVE", -"ENTITY_STATUS_ARCHIVED", -"ENTITY_STATUS_DRAFT", -"ENTITY_STATUS_PAUSED", -"ENTITY_STATUS_SCHEDULED_FOR_DELETION" -], -"enumDescriptions": [ -"Default value when status is not specified or is unknown in this version.", -"The entity is enabled to bid and spend budget.", -"The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", -"The entity is under draft. Bidding and budget spending are disabled.", -"Bidding and budget spending are paused for the entity.", -"The entity is scheduled for deletion." -], -"type": "string" -}, -"sellerPauseReason": { -"description": "Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.", -"readOnly": true, -"type": "string" -}, -"sellerStatus": { -"description": "Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.", -"enum": [ -"ENTITY_STATUS_UNSPECIFIED", -"ENTITY_STATUS_ACTIVE", -"ENTITY_STATUS_ARCHIVED", -"ENTITY_STATUS_DRAFT", -"ENTITY_STATUS_PAUSED", -"ENTITY_STATUS_SCHEDULED_FOR_DELETION" -], -"enumDescriptions": [ -"Default value when status is not specified or is unknown in this version.", -"The entity is enabled to bid and spend budget.", -"The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", -"The entity is under draft. Bidding and budget spending are disabled.", -"Bidding and budget spending are paused for the entity.", -"The entity is scheduled for deletion." -], -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"InventorySourceVideoCreativeConfig": { -"description": "The configuration for video creatives.", -"id": "InventorySourceVideoCreativeConfig", -"properties": { -"duration": { -"description": "The duration requirements for the video creatives that can be assigned to the inventory source.", -"format": "google-duration", -"type": "string" -} -}, -"type": "object" -}, "Invoice": { "description": "A single invoice.", "id": "Invoice", @@ -15646,7 +14883,7 @@ true "id": "KeywordAssignedTargetingOptionDetails", "properties": { "exemptedPolicyNames": { -"description": "Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted.", +"description": "Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.", "items": { "type": "string" }, @@ -15783,7 +15020,7 @@ true }, "frequencyCap": { "$ref": "FrequencyCap", -"description": "Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN." +"description": "Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap." }, "insertionOrderId": { "description": "Required. Immutable. The unique ID of the insertion order that the line item belongs to.", @@ -15850,7 +15087,7 @@ true "YouTube video ads that aim to get more views with a variety of ad formats. Line items of this type and their targeting cannot be created or updated using the API.", "Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", "Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", -"Demand Gen ads." +"Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This enum value is only available to allowlisted users." ], "type": "string" }, @@ -15863,6 +15100,10 @@ true "readOnly": true, "type": "string" }, +"optimizeFixedBidding": { +"description": "Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`.", +"type": "boolean" +}, "pacing": { "$ref": "Pacing", "description": "Required. The budget spending speed setting of the line item." @@ -15974,7 +15215,7 @@ true "id": "LineItemBudget", "properties": { "budgetAllocationType": { -"description": "Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types.", +"description": "Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items.", "enum": [ "LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED", "LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC", @@ -16313,23 +15554,6 @@ true }, "type": "object" }, -"ListInventorySourcesResponse": { -"id": "ListInventorySourcesResponse", -"properties": { -"inventorySources": { -"description": "The list of inventory sources. This list will be absent if empty.", -"items": { -"$ref": "InventorySource" -}, -"type": "array" -}, -"nextPageToken": { -"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInventorySources` method to retrieve the next page of results.", -"type": "string" -} -}, -"type": "object" -}, "ListInvoicesResponse": { "id": "ListInvoicesResponse", "properties": { @@ -16874,27 +16098,6 @@ true }, "type": "object" }, -"Money": { -"description": "Represents an amount of money with its currency type.", -"id": "Money", -"properties": { -"currencyCode": { -"description": "The three-letter currency code defined in ISO 4217.", -"type": "string" -}, -"nanos": { -"description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", -"format": "int32", -"type": "integer" -}, -"units": { -"description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", -"format": "int64", -"type": "string" -} -}, -"type": "object" -}, "NativeContentPositionAssignedTargetingOptionDetails": { "description": "Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect.", "id": "NativeContentPositionAssignedTargetingOptionDetails", @@ -17024,7 +16227,7 @@ true "additionalProperties": { "type": "string" }, -"description": "The custom parameters to pass custom values to tracking URL template.", +"description": "The custom parameters and accompanying values to add to the tracking URL.", "type": "object" } }, @@ -17639,7 +16842,7 @@ true "type": "string" }, "markupType": { -"description": "Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`.", +"description": "Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items.", "enum": [ "PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED", "PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM", @@ -18015,47 +17218,6 @@ false }, "type": "object" }, -"RateDetails": { -"description": "The rate related settings of the inventory source.", -"id": "RateDetails", -"properties": { -"inventorySourceRateType": { -"description": "The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.", -"enum": [ -"INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED", -"INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED", -"INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR", -"INVENTORY_SOURCE_RATE_TYPE_CPD", -"INVENTORY_SOURCE_RATE_TYPE_CPH", -"INVENTORY_SOURCE_RATE_TYPE_FLAT" -], -"enumDescriptions": [ -"The rate type is not specified or is unknown in this version.", -"The rate type is CPM (Fixed).", -"The rate type is CPM (Floor).", -"The rate type is Cost per Day.", -"The rate type is Cost per Hour.", -"The rate type is Flat." -], -"type": "string" -}, -"minimumSpend": { -"$ref": "Money", -"description": "Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.", -"readOnly": true -}, -"rate": { -"$ref": "Money", -"description": "The rate for the inventory source." -}, -"unitsPurchased": { -"description": "Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.", -"format": "int64", -"type": "string" -} -}, -"type": "object" -}, "RegionalLocationListAssignedTargetingOptionDetails": { "description": "Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.", "id": "RegionalLocationListAssignedTargetingOptionDetails", @@ -18738,7 +17900,7 @@ false "id": "TargetingExpansionConfig", "properties": { "excludeDemographicExpansion": { -"description": "Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups.", +"description": "Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.", "type": "boolean" }, "excludeFirstPartyAudience": { @@ -19048,7 +18210,7 @@ true "type": "array" }, "brandSafetyVendorConfigs": { -"description": "Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR`", +"description": "Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`", "items": { "$ref": "ThirdPartyVendorConfig" }, @@ -19213,23 +18375,6 @@ true }, "type": "object" }, -"TimeRange": { -"description": "A time range.", -"id": "TimeRange", -"properties": { -"endTime": { -"description": "Required. The upper bound of a time range, inclusive.", -"format": "google-datetime", -"type": "string" -}, -"startTime": { -"description": "Required. The lower bound of a time range, inclusive.", -"format": "google-datetime", -"type": "string" -} -}, -"type": "object" -}, "TimerEvent": { "description": "Timer event of the creative.", "id": "TimerEvent", @@ -19598,7 +18743,7 @@ true "additionalProperties": { "type": "string" }, -"description": "The custom parameters to pass custom values to tracking URL template.", +"description": "The custom parameters and accompanying values to add to the tracking URL.", "type": "object" }, "descriptions": { @@ -19632,7 +18777,7 @@ true "type": "array" }, "longHeadlines": { -"description": "The list of lone headlines shown on the call-to-action banner.", +"description": "The list of long headlines shown on the call-to-action banner.", "items": { "type": "string" }, @@ -20113,7 +19258,7 @@ true "type": "string" }, "linkedMerchantId": { -"description": "Optional. The ID of the merchant which is linked to the line item for product feed.", +"description": "Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser.", "format": "int64", "type": "string" }, @@ -20236,7 +19381,7 @@ true "type": "string" }, "videoAssetId": { -"description": "Required. The YouTube video asset id. This is ad_asset.ad_asset_id.", +"description": "Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource.", "format": "int64", "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v3.json b/googleapiclient/discovery_cache/documents/displayvideo.v3.json index 0770c73f56..076c6b28ef 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v3.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v3.json @@ -377,7 +377,7 @@ "adGroupAds": { "methods": { "create": { -"description": "Creates an ad group ad.", +"description": "Creates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.", "flatPath": "v3/advertisers/{advertisersId}/adGroupAds", "httpMethod": "POST", "id": "displayvideo.advertisers.adGroupAds.create", @@ -406,7 +406,7 @@ ] }, "delete": { -"description": "Deletes an ad group ad.", +"description": "Deletes an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.", "flatPath": "v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}", "httpMethod": "DELETE", "id": "displayvideo.advertisers.adGroupAds.delete", @@ -416,7 +416,7 @@ ], "parameters": { "adGroupAdId": { -"description": "Required. The ID of the ad to delete.", +"description": "Required. The ID of the ad to delete. Only Demand Gen ads are supported.", "format": "int64", "location": "path", "pattern": "^[^/]+$", @@ -523,7 +523,7 @@ ] }, "patch": { -"description": "Updates an ad group ad.", +"description": "Updates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.", "flatPath": "v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}", "httpMethod": "PATCH", "id": "displayvideo.advertisers.adGroupAds.patch", @@ -571,7 +571,7 @@ "adGroups": { "methods": { "bulkEditAssignedTargetingOptions": { -"description": "Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.", +"description": "Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.", "flatPath": "v3/advertisers/{advertisersId}/adGroups:bulkEditAssignedTargetingOptions", "httpMethod": "POST", "id": "displayvideo.advertisers.adGroups.bulkEditAssignedTargetingOptions", @@ -654,7 +654,7 @@ ] }, "create": { -"description": "Creates a new ad group. Returns the newly created ad group if successful.", +"description": "Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.", "flatPath": "v3/advertisers/{advertisersId}/adGroups", "httpMethod": "POST", "id": "displayvideo.advertisers.adGroups.create", @@ -683,7 +683,7 @@ ] }, "delete": { -"description": "Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist.", +"description": "Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.", "flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}", "httpMethod": "DELETE", "id": "displayvideo.advertisers.adGroups.delete", @@ -800,7 +800,7 @@ ] }, "patch": { -"description": "Updates an existing ad group. Returns the updated ad group if successful.", +"description": "Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.", "flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}", "httpMethod": "PATCH", "id": "displayvideo.advertisers.adGroups.patch", @@ -850,7 +850,7 @@ "assignedTargetingOptions": { "methods": { "create": { -"description": "Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.", +"description": "Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.", "flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", "httpMethod": "POST", "id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.create", @@ -1000,7 +1000,7 @@ ] }, "delete": { -"description": "Deletes an assigned targeting option from an ad group. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.", +"description": "Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.", "flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", "httpMethod": "DELETE", "id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.delete", @@ -3313,7 +3313,7 @@ "type": "string" }, "targetingType": { -"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_INVENTORY_MODE` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)", +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_CHANNEL", @@ -3481,7 +3481,7 @@ "type": "string" }, "targetingType": { -"description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_INVENTORY_MODE` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)", +"description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_CHANNEL", @@ -4360,7 +4360,7 @@ "type": "string" }, "targetingType": { -"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE`", +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_CHANNEL", @@ -4509,7 +4509,7 @@ "type": "string" }, "targetingType": { -"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE`", +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_CHANNEL", @@ -6654,204 +6654,6 @@ } } }, -"inventorySources": { -"methods": { -"create": { -"description": "Creates a new inventory source. Returns the newly created inventory source if successful.", -"flatPath": "v3/inventorySources", -"httpMethod": "POST", -"id": "displayvideo.inventorySources.create", -"parameterOrder": [], -"parameters": { -"advertiserId": { -"description": "The ID of the advertiser that the request is being made within.", -"format": "int64", -"location": "query", -"type": "string" -}, -"partnerId": { -"description": "The ID of the partner that the request is being made within.", -"format": "int64", -"location": "query", -"type": "string" -} -}, -"path": "v3/inventorySources", -"request": { -"$ref": "InventorySource" -}, -"response": { -"$ref": "InventorySource" -}, -"scopes": [ -"https://www.googleapis.com/auth/display-video" -] -}, -"editInventorySourceReadWriteAccessors": { -"description": "Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source.", -"flatPath": "v3/inventorySources/{inventorySourcesId}:editInventorySourceReadWriteAccessors", -"httpMethod": "POST", -"id": "displayvideo.inventorySources.editInventorySourceReadWriteAccessors", -"parameterOrder": [ -"inventorySourceId" -], -"parameters": { -"inventorySourceId": { -"description": "Required. The ID of inventory source to update.", -"format": "int64", -"location": "path", -"pattern": "^[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v3/inventorySources/{+inventorySourceId}:editInventorySourceReadWriteAccessors", -"request": { -"$ref": "EditInventorySourceReadWriteAccessorsRequest" -}, -"response": { -"$ref": "InventorySourceAccessors" -}, -"scopes": [ -"https://www.googleapis.com/auth/display-video" -] -}, -"get": { -"description": "Gets an inventory source.", -"flatPath": "v3/inventorySources/{inventorySourcesId}", -"httpMethod": "GET", -"id": "displayvideo.inventorySources.get", -"parameterOrder": [ -"inventorySourceId" -], -"parameters": { -"advertiserId": { -"description": "Optional. The ID of the DV360 advertiser to which the fetched inventory source is permissioned. If the user only has access to the advertiser and not the parent partner, use this field to specify the relevant advertiser.", -"format": "int64", -"location": "query", -"type": "string" -}, -"inventorySourceId": { -"description": "Required. The ID of the inventory source to fetch.", -"format": "int64", -"location": "path", -"pattern": "^[^/]+$", -"required": true, -"type": "string" -}, -"partnerId": { -"description": "Required. The ID of the DV360 partner to which the fetched inventory source is permissioned.", -"format": "int64", -"location": "query", -"type": "string" -} -}, -"path": "v3/inventorySources/{+inventorySourceId}", -"response": { -"$ref": "InventorySource" -}, -"scopes": [ -"https://www.googleapis.com/auth/display-video" -] -}, -"list": { -"description": "Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results.", -"flatPath": "v3/inventorySources", -"httpMethod": "GET", -"id": "displayvideo.inventorySources.list", -"parameterOrder": [], -"parameters": { -"advertiserId": { -"description": "The ID of the advertiser that has access to the inventory source.", -"format": "int64", -"location": "query", -"type": "string" -}, -"filter": { -"description": "Allows filtering by inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `status.entityStatus` * `commitment` * `deliveryMethod` * `rateDetails.rateType` * `exchange` Examples: * All active inventory sources: `status.entityStatus=\"ENTITY_STATUS_ACTIVE\"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange=\"EXCHANGE_GOOGLE_AD_MANAGER\" OR exchange=\"EXCHANGE_RUBICON\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned.", -"location": "query", -"type": "string" -}, -"partnerId": { -"description": "The ID of the partner that has access to the inventory source.", -"format": "int64", -"location": "query", -"type": "string" -} -}, -"path": "v3/inventorySources", -"response": { -"$ref": "ListInventorySourcesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/display-video" -] -}, -"patch": { -"description": "Updates an existing inventory source. Returns the updated inventory source if successful.", -"flatPath": "v3/inventorySources/{inventorySourcesId}", -"httpMethod": "PATCH", -"id": "displayvideo.inventorySources.patch", -"parameterOrder": [ -"inventorySourceId" -], -"parameters": { -"advertiserId": { -"description": "The ID of the advertiser that the request is being made within.", -"format": "int64", -"location": "query", -"type": "string" -}, -"inventorySourceId": { -"description": "Output only. The unique ID of the inventory source. Assigned by the system.", -"format": "int64", -"location": "path", -"pattern": "^[^/]+$", -"required": true, -"type": "string" -}, -"partnerId": { -"description": "The ID of the partner that the request is being made within.", -"format": "int64", -"location": "query", -"type": "string" -}, -"updateMask": { -"description": "Required. The mask to control which fields to update.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -} -}, -"path": "v3/inventorySources/{+inventorySourceId}", -"request": { -"$ref": "InventorySource" -}, -"response": { -"$ref": "InventorySource" -}, -"scopes": [ -"https://www.googleapis.com/auth/display-video" -] -} -} -}, "media": { "methods": { "download": { @@ -8706,7 +8508,7 @@ } } }, -"revision": "20260331", +"revision": "20260412", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -8852,7 +8654,7 @@ "Responsive ads.", "[Effective reach ad groups] (https://support.google.com/displayvideo/answer/9173684), including in-stream and bumper ads.", "Masthead Ad that is surfaced on the top slot on the YouTube homepage.", -"Demand Gen ads." +"Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This enum value is only available to allowlisted users." ], "type": "string" }, @@ -8864,7 +8666,7 @@ }, "adGroupInventoryControl": { "$ref": "AdGroupInventoryControl", -"description": "Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups." +"description": "Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group." }, "advertiserId": { "description": "Output only. The unique ID of the advertiser the ad group belongs to.", @@ -8971,19 +8773,19 @@ }, "demandGenCarouselAd": { "$ref": "DemandGenCarouselAd", -"description": "Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd)." +"description": "Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users." }, "demandGenImageAd": { "$ref": "DemandGenImageAd", -"description": "Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd)." +"description": "Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users." }, "demandGenProductAd": { "$ref": "DemandGenProductAd", -"description": "Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd)." +"description": "Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users." }, "demandGenVideoAd": { "$ref": "DemandGenVideoAd", -"description": "Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd)." +"description": "Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users." }, "displayName": { "description": "Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.", @@ -11903,14 +11705,14 @@ "id": "BulkEditAdvertiserAssignedTargetingOptionsRequest", "properties": { "createRequests": { -"description": "The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE`", +"description": "The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`", "items": { "$ref": "CreateAssignedTargetingOptionsRequest" }, "type": "array" }, "deleteRequests": { -"description": "The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE`", +"description": "The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`", "items": { "$ref": "DeleteAssignedTargetingOptionsRequest" }, @@ -12687,7 +12489,7 @@ "id": "CarouselCard", "properties": { "callToAction": { -"description": "Required. The call-to-action button shown on the card. Must use 10 characters or less.", +"description": "Required. The text on the call-to-action button shown on the card. Must use 10 characters or less.", "type": "string" }, "finalMobileUrl": { @@ -13510,7 +13312,7 @@ "type": "string" }, "primaryAttributionModelId": { -"description": "Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items.", +"description": "Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.", "format": "int64", "type": "string" } @@ -14132,61 +13934,6 @@ false }, "type": "object" }, -"CreativeConfig": { -"description": "Creative requirements configuration for the inventory source.", -"id": "CreativeConfig", -"properties": { -"creativeType": { -"description": "The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`", -"enum": [ -"CREATIVE_TYPE_UNSPECIFIED", -"CREATIVE_TYPE_STANDARD", -"CREATIVE_TYPE_EXPANDABLE", -"CREATIVE_TYPE_VIDEO", -"CREATIVE_TYPE_NATIVE", -"CREATIVE_TYPE_TEMPLATED_APP_INSTALL", -"CREATIVE_TYPE_NATIVE_SITE_SQUARE", -"CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL", -"CREATIVE_TYPE_LIGHTBOX", -"CREATIVE_TYPE_NATIVE_APP_INSTALL", -"CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE", -"CREATIVE_TYPE_AUDIO", -"CREATIVE_TYPE_PUBLISHER_HOSTED", -"CREATIVE_TYPE_NATIVE_VIDEO", -"CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO", -"CREATIVE_TYPE_ASSET_BASED_CREATIVE" -], -"enumDescriptions": [ -"Type value is not specified or is unknown in this version.", -"Standard display creative. Create and update methods are supported for this creative type if the hosting_source is one of the following: * `HOSTING_SOURCE_HOSTED` * `HOSTING_SOURCE_THIRD_PARTY`", -"Expandable creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_THIRD_PARTY`", -"Video creative. Create and update methods are supported for this creative type if the hosting_source is one of the following: * `HOSTING_SOURCE_HOSTED` * `HOSTING_SOURCE_THIRD_PARTY`", -"Native creative rendered by publishers with assets from advertiser. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", -"Templated app install mobile creative (banner). Create and update methods are **not** supported for this creative type.", -"Square native creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", -"Interstitial creative including both display and video. Create and update methods are **not** supported for this creative type.", -"Responsive and expandable Lightbox creative. Create and update methods are **not** supported for this creative type.", -"Native app install creative. Create and update methods are **not** supported for this creative type.", -"Square native app install creative. Create and update methods are **not** supported for this creative type.", -"Audio creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", -"Publisher hosted creative. Create and update methods are **not** supported for this creative type.", -"Native video creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", -"Templated app install mobile video creative. Create and update methods are **not** supported for this creative type.", -"Asset-based creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`." -], -"type": "string" -}, -"displayCreativeConfig": { -"$ref": "InventorySourceDisplayCreativeConfig", -"description": "The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`." -}, -"videoCreativeConfig": { -"$ref": "InventorySourceVideoCreativeConfig", -"description": "The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`." -} -}, -"type": "object" -}, "CustomBiddingAlgorithm": { "description": "A single custom bidding algorithm.", "id": "CustomBiddingAlgorithm", @@ -14703,7 +14450,7 @@ false "type": "integer" }, "timeZoneResolution": { -"description": "Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER.", +"description": "Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`.", "enum": [ "TIME_ZONE_RESOLUTION_UNSPECIFIED", "TIME_ZONE_RESOLUTION_END_USER", @@ -14868,7 +14615,7 @@ false "id": "DemandGenBiddingStrategy", "properties": { "effectiveBiddingValue": { -"description": "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.", +"description": "Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0.", "format": "int64", "readOnly": true, "type": "string" @@ -14889,14 +14636,15 @@ false "type": "string" }, "type": { -"description": "Optional. The type of the bidding strategy. This can only be set at the line item level.", +"description": "Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item.", "enum": [ "DEMAND_GEN_BIDDING_STRATEGY_TYPE_UNSPECIFIED", "DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA", "DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS", "DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS", "DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE", -"DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CLICKS" +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CLICKS", +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC" ], "enumDescriptions": [ "Type is not specified or unknown.", @@ -14904,12 +14652,13 @@ false "A bidding strategy that automatically maximizes revenue while averaging a specific target Return On Ad Spend (ROAS).", "A bidding strategy that automatically maximizes number of conversions", "A bidding strategy that automatically maximizes revenue while spending your budget.", -"A bidding strategy that automatically maximizes clicks within a given budget." +"A bidding strategy that automatically maximizes clicks within a given budget.", +"A bidding strategy that automatically optimizes cost per click." ], "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_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.", +"description": "Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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" } @@ -14935,7 +14684,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Optional. The custom parameters to pass custom values to tracking URL template.", +"description": "Optional. The custom parameters and accompanying values to add to the tracking URL.", "type": "object" }, "description": { @@ -14986,7 +14735,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Optional. The custom parameters to pass custom values to tracking URL template.", +"description": "Optional. The custom parameters and accompanying values to add to the tracking URL.", "type": "object" }, "descriptions": { @@ -15113,7 +14862,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Optional. The custom parameters to pass custom values to tracking URL template.", +"description": "Optional. The custom parameters and accompanying values to add to the tracking URL.", "type": "object" }, "description": { @@ -15161,11 +14910,11 @@ false "id": "DemandGenSettings", "properties": { "geoLanguageTargetingEnabled": { -"description": "Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups.", +"description": "Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups.", "type": "boolean" }, "linkedMerchantId": { -"description": "Optional. The ID of the merchant which is linked to the line item for product feed.", +"description": "Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser.", "format": "int64", "type": "string" }, @@ -15238,7 +14987,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Optional. The custom parameters to pass custom values to tracking URL template.", +"description": "Optional. The custom parameters and accompanying values to add to the tracking URL.", "type": "object" }, "descriptions": { @@ -15280,7 +15029,7 @@ false "description": "Required. The logo image used by this ad." }, "longHeadlines": { -"description": "Required. The list of lone headlines shown on the ad.", +"description": "Required. The list of long headlines shown on the ad.", "items": { "type": "string" }, @@ -15958,49 +15707,6 @@ false }, "type": "object" }, -"EditInventorySourceReadWriteAccessorsRequest": { -"description": "Request message for InventorySourceService.EditInventorySourceReadWriteAccessors.", -"id": "EditInventorySourceReadWriteAccessorsRequest", -"properties": { -"advertisersUpdate": { -"$ref": "EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate", -"description": "The advertisers to add or remove from the list of advertisers that have read/write access to the inventory source. This change will remove an existing partner read/write accessor." -}, -"assignPartner": { -"description": "Set the partner context as read/write accessor of the inventory source. This will remove all other current read/write advertiser accessors.", -"type": "boolean" -}, -"partnerId": { -"description": "Required. The partner context by which the accessors change is being made.", -"format": "int64", -"type": "string" -} -}, -"type": "object" -}, -"EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate": { -"description": "Update to the list of advertisers with read/write access to the inventory source.", -"id": "EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate", -"properties": { -"addedAdvertisers": { -"description": "The advertisers to add.", -"items": { -"format": "int64", -"type": "string" -}, -"type": "array" -}, -"removedAdvertisers": { -"description": "The advertisers to remove.", -"items": { -"format": "int64", -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -18179,7 +17885,7 @@ false "additionalProperties": { "type": "string" }, -"description": "The custom parameters to pass custom values to tracking URL template.", +"description": "The custom parameters and accompanying values to add to the tracking URL.", "type": "object" } }, @@ -18629,423 +18335,32 @@ false }, "type": "object" }, -"InventorySource": { -"description": "An inventory source. Next ID: 22", -"id": "InventorySource", +"InventorySourceAssignedTargetingOptionDetails": { +"description": "Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.", +"id": "InventorySourceAssignedTargetingOptionDetails", "properties": { -"commitment": { -"description": "Whether the inventory source has a guaranteed or non-guaranteed delivery.", -"enum": [ -"INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED", -"INVENTORY_SOURCE_COMMITMENT_GUARANTEED", -"INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED" -], -"enumDescriptions": [ -"The commitment is not specified or is unknown in this version.", -"The commitment is guaranteed delivery.", -"The commitment is non-guaranteed delivery." -], +"inventorySourceId": { +"description": "Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.", +"format": "int64", "type": "string" +} +}, +"type": "object" }, -"creativeConfigs": { -"description": "The creative requirements of the inventory source. Not applicable for auction packages.", +"InventorySourceFilter": { +"description": "A filtering option for filtering on Inventory Source entities.", +"id": "InventorySourceFilter", +"properties": { +"inventorySourceIds": { +"description": "Inventory Sources to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Leave empty to download all Inventory Sources for the selected Advertiser or Partner.", "items": { -"$ref": "CreativeConfig" +"format": "int64", +"type": "string" }, "type": "array" +} }, -"dealId": { -"description": "The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges.", -"type": "string" -}, -"deliveryMethod": { -"description": "The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`.", -"enum": [ -"INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED", -"INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC", -"INVENTORY_SOURCE_DELIVERY_METHOD_TAG" -], -"enumDescriptions": [ -"The delivery method is not specified or is unknown in this version.", -"The delivery method is programmatic.", -"The delivery method is tag." -], -"type": "string" -}, -"displayName": { -"description": "The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes.", -"type": "string" -}, -"exchange": { -"description": "The exchange to which the inventory source belongs.", -"enum": [ -"EXCHANGE_UNSPECIFIED", -"EXCHANGE_GOOGLE_AD_MANAGER", -"EXCHANGE_APPNEXUS", -"EXCHANGE_BRIGHTROLL", -"EXCHANGE_ADFORM", -"EXCHANGE_ADMETA", -"EXCHANGE_ADMIXER", -"EXCHANGE_ADSMOGO", -"EXCHANGE_ADSWIZZ", -"EXCHANGE_BIDSWITCH", -"EXCHANGE_BRIGHTROLL_DISPLAY", -"EXCHANGE_CADREON", -"EXCHANGE_DAILYMOTION", -"EXCHANGE_FIVE", -"EXCHANGE_FLUCT", -"EXCHANGE_FREEWHEEL", -"EXCHANGE_GENIEE", -"EXCHANGE_GUMGUM", -"EXCHANGE_IMOBILE", -"EXCHANGE_IBILLBOARD", -"EXCHANGE_IMPROVE_DIGITAL", -"EXCHANGE_INDEX", -"EXCHANGE_KARGO", -"EXCHANGE_MICROAD", -"EXCHANGE_MOPUB", -"EXCHANGE_NEND", -"EXCHANGE_ONE_BY_AOL_DISPLAY", -"EXCHANGE_ONE_BY_AOL_MOBILE", -"EXCHANGE_ONE_BY_AOL_VIDEO", -"EXCHANGE_OOYALA", -"EXCHANGE_OPENX", -"EXCHANGE_PERMODO", -"EXCHANGE_PLATFORMONE", -"EXCHANGE_PLATFORMID", -"EXCHANGE_PUBMATIC", -"EXCHANGE_PULSEPOINT", -"EXCHANGE_REVENUEMAX", -"EXCHANGE_RUBICON", -"EXCHANGE_SMARTCLIP", -"EXCHANGE_SMARTRTB", -"EXCHANGE_SMARTSTREAMTV", -"EXCHANGE_SOVRN", -"EXCHANGE_SPOTXCHANGE", -"EXCHANGE_STROER", -"EXCHANGE_TEADSTV", -"EXCHANGE_TELARIA", -"EXCHANGE_TVN", -"EXCHANGE_UNITED", -"EXCHANGE_YIELDLAB", -"EXCHANGE_YIELDMO", -"EXCHANGE_UNRULYX", -"EXCHANGE_OPEN8", -"EXCHANGE_TRITON", -"EXCHANGE_TRIPLELIFT", -"EXCHANGE_TABOOLA", -"EXCHANGE_INMOBI", -"EXCHANGE_SMAATO", -"EXCHANGE_AJA", -"EXCHANGE_SUPERSHIP", -"EXCHANGE_NEXSTAR_DIGITAL", -"EXCHANGE_WAZE", -"EXCHANGE_SOUNDCAST", -"EXCHANGE_SHARETHROUGH", -"EXCHANGE_FYBER", -"EXCHANGE_RED_FOR_PUBLISHERS", -"EXCHANGE_MEDIANET", -"EXCHANGE_TAPJOY", -"EXCHANGE_VISTAR", -"EXCHANGE_DAX", -"EXCHANGE_JCD", -"EXCHANGE_PLACE_EXCHANGE", -"EXCHANGE_APPLOVIN", -"EXCHANGE_CONNATIX", -"EXCHANGE_RESET_DIGITAL", -"EXCHANGE_HIVESTACK", -"EXCHANGE_DRAX", -"EXCHANGE_APPLOVIN_GBID", -"EXCHANGE_FYBER_GBID", -"EXCHANGE_UNITY_GBID", -"EXCHANGE_CHARTBOOST_GBID", -"EXCHANGE_ADMOST_GBID", -"EXCHANGE_TOPON_GBID", -"EXCHANGE_NETFLIX", -"EXCHANGE_CORE", -"EXCHANGE_COMMERCE_GRID", -"EXCHANGE_SPOTIFY", -"EXCHANGE_TUBI", -"EXCHANGE_SNAP", -"EXCHANGE_CADENT" -], -"enumDescriptions": [ -"Exchange is not specified or is unknown in this version.", -"Google Ad Manager.", -"AppNexus.", -"BrightRoll Exchange for Video from Yahoo!.", -"Adform.", -"Admeta.", -"Admixer.", -"AdsMogo.", -"AdsWizz.", -"BidSwitch.", -"BrightRoll Exchange for Display from Yahoo!.", -"Cadreon.", -"Dailymotion.", -"Five.", -"Fluct.", -"FreeWheel SSP.", -"Geniee.", -"GumGum.", -"i-mobile.", -"iBILLBOARD.", -"Improve Digital.", -"Index Exchange.", -"Kargo.", -"MicroAd.", -"MoPub.", -"Nend.", -"ONE by AOL: Display Market Place.", -"ONE by AOL: Mobile.", -"ONE by AOL: Video.", -"Ooyala.", -"OpenX.", -"Permodo.", -"Platform One.", -"PlatformId.", -"PubMatic.", -"PulsePoint.", -"RevenueMax.", -"Rubicon.", -"SmartClip.", -"SmartRTB+.", -"SmartstreamTv.", -"Sovrn.", -"SpotXchange.", -"Str\u00f6er SSP.", -"TeadsTv.", -"Telaria.", -"TVN.", -"United.", -"Yieldlab.", -"Yieldmo.", -"UnrulyX.", -"Open8.", -"Triton.", -"TripleLift.", -"Taboola.", -"InMobi.", -"Smaato.", -"Aja.", -"Supership.", -"Nexstar Digital.", -"Waze.", -"SoundCast.", -"Sharethrough.", -"Fyber.", -"Red For Publishers.", -"Media.net.", -"Tapjoy.", -"Vistar.", -"DAX.", -"JCD.", -"Place Exchange.", -"AppLovin.", -"Connatix.", -"Reset Digital.", -"Hivestack.", -"Drax.", -"AppLovin MAX.", -"DT Fairbid.", -"Unity LevelPlay.", -"Chartboost Mediation.", -"AdMost.", -"TopOn.", -"Netflix.", -"Core.", -"Commerce Grid.", -"Spotify.", -"Tubi.", -"Snap.", -"Cadent." -], -"type": "string" -}, -"guaranteedOrderId": { -"description": "Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.", -"type": "string" -}, -"inventorySourceId": { -"description": "Output only. The unique ID of the inventory source. Assigned by the system.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"inventorySourceProductType": { -"description": "Output only. The product type of the inventory source, denoting the way through which it sells inventory.", -"enum": [ -"INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED", -"PREFERRED_DEAL", -"PRIVATE_AUCTION", -"PROGRAMMATIC_GUARANTEED", -"TAG_GUARANTEED", -"YOUTUBE_RESERVE", -"INSTANT_RESERVE", -"GUARANTEED_PACKAGE", -"PROGRAMMATIC_TV", -"AUCTION_PACKAGE" -], -"enumDescriptions": [ -"The product type is not specified or is unknown in this version. Modifying inventory sources of this product type are not supported via API.", -"The inventory source sells inventory through Preferred Deal.", -"The inventory source sells inventory through Private Auction.", -"The inventory source sells inventory through Programmatic Guaranteed.", -"The inventory source sells inventory through Tag Guaranteed.", -"The inventory source sells inventory through YouTube Reserve.", -"The inventory source sells inventory through Instant Reserve. Modifying inventory sources of this product type are not supported via API.", -"The inventory source sells inventory through Guaranteed Package. Modifying inventory sources of this product type are not supported via API.", -"The inventory source sells inventory through Programmtic TV. Modifying inventory sources of this product type are not supported via API.", -"The inventory source sells inventory through Auction Package. Modifying inventory sources of this product type are not supported via API." -], -"readOnly": true, -"type": "string" -}, -"inventorySourceType": { -"description": "Denotes the type of the inventory source.", -"enum": [ -"INVENTORY_SOURCE_TYPE_UNSPECIFIED", -"INVENTORY_SOURCE_TYPE_PRIVATE", -"INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE" -], -"enumDescriptions": [ -"The inventory source type is not specified or is unknown in this version.", -"Private inventory source.", -"Auction package." -], -"type": "string" -}, -"name": { -"description": "Output only. The resource name of the inventory source.", -"readOnly": true, -"type": "string" -}, -"publisherName": { -"description": "The publisher/seller name of the inventory source.", -"type": "string" -}, -"rateDetails": { -"$ref": "RateDetails", -"description": "Required. The rate details of the inventory source." -}, -"readAdvertiserIds": { -"description": "Output only. The IDs of advertisers with read-only access to the inventory source.", -"items": { -"format": "int64", -"type": "string" -}, -"readOnly": true, -"type": "array" -}, -"readPartnerIds": { -"description": "Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.", -"items": { -"format": "int64", -"type": "string" -}, -"readOnly": true, -"type": "array" -}, -"readWriteAccessors": { -"$ref": "InventorySourceAccessors", -"description": "The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids." -}, -"status": { -"$ref": "InventorySourceStatus", -"description": "The status settings of the inventory source." -}, -"timeRange": { -"$ref": "TimeRange", -"description": "The time range when this inventory source starts and stops serving." -}, -"updateTime": { -"description": "Output only. The timestamp when the inventory source was last updated. Assigned by the system.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"InventorySourceAccessors": { -"description": "The partner or advertisers with access to the inventory source.", -"id": "InventorySourceAccessors", -"properties": { -"advertisers": { -"$ref": "InventorySourceAccessorsAdvertiserAccessors", -"description": "The advertisers with access to the inventory source. All advertisers must belong to the same partner." -}, -"partner": { -"$ref": "InventorySourceAccessorsPartnerAccessor", -"description": "The partner with access to the inventory source." -} -}, -"type": "object" -}, -"InventorySourceAccessorsAdvertiserAccessors": { -"description": "The advertisers with access to the inventory source.", -"id": "InventorySourceAccessorsAdvertiserAccessors", -"properties": { -"advertiserIds": { -"description": "The IDs of the advertisers.", -"items": { -"format": "int64", -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"InventorySourceAccessorsPartnerAccessor": { -"description": "The partner with access to the inventory source.", -"id": "InventorySourceAccessorsPartnerAccessor", -"properties": { -"partnerId": { -"description": "The ID of the partner.", -"format": "int64", -"type": "string" -} -}, -"type": "object" -}, -"InventorySourceAssignedTargetingOptionDetails": { -"description": "Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.", -"id": "InventorySourceAssignedTargetingOptionDetails", -"properties": { -"inventorySourceId": { -"description": "Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.", -"format": "int64", -"type": "string" -} -}, -"type": "object" -}, -"InventorySourceDisplayCreativeConfig": { -"description": "The configuration for display creatives.", -"id": "InventorySourceDisplayCreativeConfig", -"properties": { -"creativeSize": { -"$ref": "Dimensions", -"description": "The size requirements for display creatives that can be assigned to the inventory source." -} -}, -"type": "object" -}, -"InventorySourceFilter": { -"description": "A filtering option for filtering on Inventory Source entities.", -"id": "InventorySourceFilter", -"properties": { -"inventorySourceIds": { -"description": "Inventory Sources to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Leave empty to download all Inventory Sources for the selected Advertiser or Partner.", -"items": { -"format": "int64", -"type": "string" -}, -"type": "array" -} -}, -"type": "object" +"type": "object" }, "InventorySourceGroup": { "description": "A collection of targetable inventory sources.", @@ -19081,90 +18396,6 @@ false }, "type": "object" }, -"InventorySourceStatus": { -"description": "The status related settings of the inventory source.", -"id": "InventorySourceStatus", -"properties": { -"configStatus": { -"description": "Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.", -"enum": [ -"INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED", -"INVENTORY_SOURCE_CONFIG_STATUS_PENDING", -"INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED" -], -"enumDescriptions": [ -"The approval status is not specified or is unknown in this version.", -"The beginning state of a guaranteed inventory source. The inventory source in this state needs to be configured.", -"The state after the buyer configures a guaranteed inventory source." -], -"readOnly": true, -"type": "string" -}, -"entityPauseReason": { -"description": "The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.", -"type": "string" -}, -"entityStatus": { -"description": "Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.", -"enum": [ -"ENTITY_STATUS_UNSPECIFIED", -"ENTITY_STATUS_ACTIVE", -"ENTITY_STATUS_ARCHIVED", -"ENTITY_STATUS_DRAFT", -"ENTITY_STATUS_PAUSED", -"ENTITY_STATUS_SCHEDULED_FOR_DELETION" -], -"enumDescriptions": [ -"Default value when status is not specified or is unknown in this version.", -"The entity is enabled to bid and spend budget.", -"The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", -"The entity is under draft. Bidding and budget spending are disabled.", -"Bidding and budget spending are paused for the entity.", -"The entity is scheduled for deletion." -], -"type": "string" -}, -"sellerPauseReason": { -"description": "Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.", -"readOnly": true, -"type": "string" -}, -"sellerStatus": { -"description": "Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.", -"enum": [ -"ENTITY_STATUS_UNSPECIFIED", -"ENTITY_STATUS_ACTIVE", -"ENTITY_STATUS_ARCHIVED", -"ENTITY_STATUS_DRAFT", -"ENTITY_STATUS_PAUSED", -"ENTITY_STATUS_SCHEDULED_FOR_DELETION" -], -"enumDescriptions": [ -"Default value when status is not specified or is unknown in this version.", -"The entity is enabled to bid and spend budget.", -"The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", -"The entity is under draft. Bidding and budget spending are disabled.", -"Bidding and budget spending are paused for the entity.", -"The entity is scheduled for deletion." -], -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"InventorySourceVideoCreativeConfig": { -"description": "The configuration for video creatives.", -"id": "InventorySourceVideoCreativeConfig", -"properties": { -"duration": { -"description": "The duration requirements for the video creatives that can be assigned to the inventory source.", -"format": "google-duration", -"type": "string" -} -}, -"type": "object" -}, "Invoice": { "description": "A single invoice.", "id": "Invoice", @@ -19277,7 +18508,7 @@ false "id": "KeywordAssignedTargetingOptionDetails", "properties": { "exemptedPolicyNames": { -"description": "Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted.", +"description": "Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.", "items": { "type": "string" }, @@ -19490,7 +18721,7 @@ false }, "frequencyCap": { "$ref": "FrequencyCap", -"description": "Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN." +"description": "Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap." }, "insertionOrderId": { "description": "Required. Immutable. The unique ID of the insertion order that the line item belongs to.", @@ -19557,7 +18788,7 @@ false "YouTube video ads that aim to get more views with a variety of ad formats. Line items of this type and their targeting cannot be created or updated using the API.", "Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", "Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", -"Demand Gen ads." +"Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This enum value is only available to allowlisted users." ], "type": "string" }, @@ -19570,6 +18801,10 @@ false "readOnly": true, "type": "string" }, +"optimizeFixedBidding": { +"description": "Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`.", +"type": "boolean" +}, "pacing": { "$ref": "Pacing", "description": "Required. The budget spending speed setting of the line item." @@ -19679,7 +18914,7 @@ false "id": "LineItemBudget", "properties": { "budgetAllocationType": { -"description": "Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types.", +"description": "Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items.", "enum": [ "LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED", "LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC", @@ -20104,23 +19339,6 @@ false }, "type": "object" }, -"ListInventorySourcesResponse": { -"id": "ListInventorySourcesResponse", -"properties": { -"inventorySources": { -"description": "The list of inventory sources. This list will be absent if empty.", -"items": { -"$ref": "InventorySource" -}, -"type": "array" -}, -"nextPageToken": { -"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInventorySources` method to retrieve the next page of results.", -"type": "string" -} -}, -"type": "object" -}, "ListInvoicesResponse": { "id": "ListInvoicesResponse", "properties": { @@ -20561,27 +19779,6 @@ false }, "type": "object" }, -"Money": { -"description": "Represents an amount of money with its currency type.", -"id": "Money", -"properties": { -"currencyCode": { -"description": "The three-letter currency code defined in ISO 4217.", -"type": "string" -}, -"nanos": { -"description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", -"format": "int32", -"type": "integer" -}, -"units": { -"description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", -"format": "int64", -"type": "string" -} -}, -"type": "object" -}, "NativeContentPositionAssignedTargetingOptionDetails": { "description": "Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect.", "id": "NativeContentPositionAssignedTargetingOptionDetails", @@ -20711,7 +19908,7 @@ false "additionalProperties": { "type": "string" }, -"description": "The custom parameters to pass custom values to tracking URL template.", +"description": "The custom parameters and accompanying values to add to the tracking URL.", "type": "object" } }, @@ -21381,7 +20578,7 @@ false "type": "string" }, "markupType": { -"description": "Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`.", +"description": "Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items.", "enum": [ "PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED", "PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM", @@ -21757,47 +20954,6 @@ false }, "type": "object" }, -"RateDetails": { -"description": "The rate related settings of the inventory source.", -"id": "RateDetails", -"properties": { -"inventorySourceRateType": { -"description": "The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`.", -"enum": [ -"INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED", -"INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED", -"INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR", -"INVENTORY_SOURCE_RATE_TYPE_CPD", -"INVENTORY_SOURCE_RATE_TYPE_CPH", -"INVENTORY_SOURCE_RATE_TYPE_FLAT" -], -"enumDescriptions": [ -"The rate type is not specified or is unknown in this version.", -"The rate type is CPM (Fixed).", -"The rate type is CPM (Floor).", -"The rate type is Cost per Day.", -"The rate type is Cost per Hour.", -"The rate type is Flat." -], -"type": "string" -}, -"minimumSpend": { -"$ref": "Money", -"description": "Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources.", -"readOnly": true -}, -"rate": { -"$ref": "Money", -"description": "The rate for the inventory source." -}, -"unitsPurchased": { -"description": "Required for guaranteed inventory sources. The number of impressions guaranteed by the seller.", -"format": "int64", -"type": "string" -} -}, -"type": "object" -}, "RegionalLocationListAssignedTargetingOptionDetails": { "description": "Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.", "id": "RegionalLocationListAssignedTargetingOptionDetails", @@ -22256,7 +21412,7 @@ false "type": "boolean" }, "allowYoutubeStream": { -"description": "Whether the ad group is opted-in to YouTube in-stream.", +"description": "Whether the ad group is opted-in to YouTube in-stream inventory.", "type": "boolean" } }, @@ -22539,7 +21695,7 @@ false "type": "boolean" }, "excludeDemographicExpansion": { -"description": "Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups.", +"description": "Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.", "type": "boolean" } }, @@ -22819,7 +21975,7 @@ false "type": "array" }, "brandSafetyVendorConfigs": { -"description": "Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR`", +"description": "Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`", "items": { "$ref": "ThirdPartyVendorConfig" }, @@ -22984,23 +22140,6 @@ false }, "type": "object" }, -"TimeRange": { -"description": "A time range.", -"id": "TimeRange", -"properties": { -"endTime": { -"description": "Required. The upper bound of a time range, inclusive.", -"format": "google-datetime", -"type": "string" -}, -"startTime": { -"description": "Required. The lower bound of a time range, inclusive.", -"format": "google-datetime", -"type": "string" -} -}, -"type": "object" -}, "TimerEvent": { "description": "Timer event of the creative.", "id": "TimerEvent", @@ -23369,7 +22508,7 @@ false "additionalProperties": { "type": "string" }, -"description": "The custom parameters to pass custom values to tracking URL template.", +"description": "The custom parameters and accompanying values to add to the tracking URL.", "type": "object" }, "descriptions": { @@ -23403,7 +22542,7 @@ false "type": "array" }, "longHeadlines": { -"description": "The list of lone headlines shown on the call-to-action banner.", +"description": "The list of long headlines shown on the call-to-action banner.", "items": { "type": "string" }, @@ -23675,7 +22814,7 @@ false "type": "string" }, "linkedMerchantId": { -"description": "Optional. The ID of the merchant which is linked to the line item for product feed.", +"description": "Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser.", "format": "int64", "type": "string" }, @@ -23763,7 +22902,7 @@ false "type": "string" }, "videoAssetId": { -"description": "Required. The YouTube video asset id. This is ad_asset.ad_asset_id.", +"description": "Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource.", "format": "int64", "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v4.json b/googleapiclient/discovery_cache/documents/displayvideo.v4.json index 9cdf168597..04bb9d854f 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v4.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v4.json @@ -562,7 +562,7 @@ "adGroupAds": { "methods": { "create": { -"description": "Creates an ad group ad.", +"description": "Creates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.", "flatPath": "v4/advertisers/{advertisersId}/adGroupAds", "httpMethod": "POST", "id": "displayvideo.advertisers.adGroupAds.create", @@ -591,7 +591,7 @@ ] }, "delete": { -"description": "Deletes an ad group ad.", +"description": "Deletes an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.", "flatPath": "v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}", "httpMethod": "DELETE", "id": "displayvideo.advertisers.adGroupAds.delete", @@ -601,7 +601,7 @@ ], "parameters": { "adGroupAdId": { -"description": "Required. The ID of the ad to delete.", +"description": "Required. The ID of the ad to delete. Only Demand Gen ads are supported.", "format": "int64", "location": "path", "pattern": "^[^/]+$", @@ -708,7 +708,7 @@ ] }, "patch": { -"description": "Updates an ad group ad.", +"description": "Updates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.", "flatPath": "v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}", "httpMethod": "PATCH", "id": "displayvideo.advertisers.adGroupAds.patch", @@ -756,7 +756,7 @@ "adGroups": { "methods": { "bulkEditAssignedTargetingOptions": { -"description": "Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.", +"description": "Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.", "flatPath": "v4/advertisers/{advertisersId}/adGroups:bulkEditAssignedTargetingOptions", "httpMethod": "POST", "id": "displayvideo.advertisers.adGroups.bulkEditAssignedTargetingOptions", @@ -839,7 +839,7 @@ ] }, "create": { -"description": "Creates a new ad group. Returns the newly created ad group if successful.", +"description": "Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.", "flatPath": "v4/advertisers/{advertisersId}/adGroups", "httpMethod": "POST", "id": "displayvideo.advertisers.adGroups.create", @@ -868,7 +868,7 @@ ] }, "delete": { -"description": "Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist.", +"description": "Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.", "flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}", "httpMethod": "DELETE", "id": "displayvideo.advertisers.adGroups.delete", @@ -985,7 +985,7 @@ ] }, "patch": { -"description": "Updates an existing ad group. Returns the updated ad group if successful.", +"description": "Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.", "flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}", "httpMethod": "PATCH", "id": "displayvideo.advertisers.adGroups.patch", @@ -1035,7 +1035,7 @@ "assignedTargetingOptions": { "methods": { "create": { -"description": "Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.", +"description": "Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.", "flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", "httpMethod": "POST", "id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.create", @@ -1185,7 +1185,7 @@ ] }, "delete": { -"description": "Deletes an assigned targeting option from an ad group. Only ad groups under a line item of line_item_type `LINE_ITEM_TYPE_DEMAND_GEN` are supported for this method.", +"description": "Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`. Retrieval and management of Demand Gen resources is currently in beta. This method is only available to allowlisted users.", "flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", "httpMethod": "DELETE", "id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.delete", @@ -3717,7 +3717,7 @@ "type": "string" }, "targetingType": { -"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_INVENTORY_MODE` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)", +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_CHANNEL", @@ -3885,7 +3885,7 @@ "type": "string" }, "targetingType": { -"description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_INVENTORY_MODE` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)", +"description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_CHANNEL", @@ -4983,7 +4983,7 @@ "type": "string" }, "targetingType": { -"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE`", +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_CHANNEL", @@ -5132,7 +5132,7 @@ "type": "string" }, "targetingType": { -"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE`", +"description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`", "enum": [ "TARGETING_TYPE_UNSPECIFIED", "TARGETING_TYPE_CHANNEL", @@ -9363,7 +9363,7 @@ } } }, -"revision": "20260331", +"revision": "20260412", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -9565,7 +9565,7 @@ "Responsive ads.", "[Effective reach ad groups] (https://support.google.com/displayvideo/answer/9173684), including in-stream and bumper ads.", "Masthead Ad that is surfaced on the top slot on the YouTube homepage.", -"Demand Gen ads." +"Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This enum value is only available to allowlisted users." ], "type": "string" }, @@ -9577,7 +9577,7 @@ }, "adGroupInventoryControl": { "$ref": "AdGroupInventoryControl", -"description": "Optional. Specifies the inventory control of the ad group. This field is required for Demand Gen ad groups." +"description": "Optional. Required for Demand Gen ad groups. Specifies the inventory control of the ad group." }, "advertiserId": { "description": "Output only. The unique ID of the advertiser the ad group belongs to.", @@ -9684,19 +9684,19 @@ }, "demandGenCarouselAd": { "$ref": "DemandGenCarouselAd", -"description": "Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd)." +"description": "Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users." }, "demandGenImageAd": { "$ref": "DemandGenImageAd", -"description": "Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd)." +"description": "Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users." }, "demandGenProductAd": { "$ref": "DemandGenProductAd", -"description": "Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd)." +"description": "Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users." }, "demandGenVideoAd": { "$ref": "DemandGenVideoAd", -"description": "Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd)." +"description": "Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users." }, "displayName": { "description": "Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.", @@ -12644,14 +12644,14 @@ "id": "BulkEditAdvertiserAssignedTargetingOptionsRequest", "properties": { "createRequests": { -"description": "The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE`", +"description": "The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`", "items": { "$ref": "CreateAssignedTargetingOptionsRequest" }, "type": "array" }, "deleteRequests": { -"description": "The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_INVENTORY_MODE`", +"description": "The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_KEYWORD`", "items": { "$ref": "DeleteAssignedTargetingOptionsRequest" }, @@ -13428,7 +13428,7 @@ "id": "CarouselCard", "properties": { "callToAction": { -"description": "Required. The call-to-action button shown on the card. Must use 10 characters or less.", +"description": "Required. The text on the call-to-action button shown on the card. Must use 10 characters or less.", "type": "string" }, "finalMobileUrl": { @@ -14251,7 +14251,7 @@ "type": "string" }, "primaryAttributionModelId": { -"description": "Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items.", +"description": "Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.", "format": "int64", "type": "string" } @@ -15458,7 +15458,7 @@ false "type": "integer" }, "timeZoneResolution": { -"description": "Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For demand gen line items, this field is always TIME_ZONE_RESOLUTION_ADVERTISER.", +"description": "Required. The mechanism used to determine which timezone to use for this day and time targeting setting. For Demand Gen line items, this field is always `TIME_ZONE_RESOLUTION_ADVERTISER`.", "enum": [ "TIME_ZONE_RESOLUTION_UNSPECIFIED", "TIME_ZONE_RESOLUTION_END_USER", @@ -15623,7 +15623,7 @@ false "id": "DemandGenBiddingStrategy", "properties": { "effectiveBiddingValue": { -"description": "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.", +"description": "Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0.", "format": "int64", "readOnly": true, "type": "string" @@ -15644,14 +15644,15 @@ false "type": "string" }, "type": { -"description": "Optional. The type of the bidding strategy. This can only be set at the line item level.", +"description": "Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item.", "enum": [ "DEMAND_GEN_BIDDING_STRATEGY_TYPE_UNSPECIFIED", "DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA", "DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS", "DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS", "DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE", -"DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CLICKS" +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CLICKS", +"DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC" ], "enumDescriptions": [ "Type is not specified or unknown.", @@ -15659,12 +15660,13 @@ false "A bidding strategy that automatically maximizes revenue while averaging a specific target Return On Ad Spend (ROAS).", "A bidding strategy that automatically maximizes number of conversions", "A bidding strategy that automatically maximizes revenue while spending your budget.", -"A bidding strategy that automatically maximizes clicks within a given budget." +"A bidding strategy that automatically maximizes clicks within a given budget.", +"A bidding strategy that automatically optimizes cost per click." ], "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_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.", +"description": "Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. 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" } @@ -15690,7 +15692,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Optional. The custom parameters to pass custom values to tracking URL template.", +"description": "Optional. The custom parameters and accompanying values to add to the tracking URL.", "type": "object" }, "description": { @@ -15741,7 +15743,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Optional. The custom parameters to pass custom values to tracking URL template.", +"description": "Optional. The custom parameters and accompanying values to add to the tracking URL.", "type": "object" }, "descriptions": { @@ -15868,7 +15870,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Optional. The custom parameters to pass custom values to tracking URL template.", +"description": "Optional. The custom parameters and accompanying values to add to the tracking URL.", "type": "object" }, "description": { @@ -15916,11 +15918,11 @@ false "id": "DemandGenSettings", "properties": { "geoLanguageTargetingEnabled": { -"description": "Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to the ad groups.", +"description": "Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups.", "type": "boolean" }, "linkedMerchantId": { -"description": "Optional. The ID of the merchant which is linked to the line item for product feed.", +"description": "Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser.", "format": "int64", "type": "string" }, @@ -15993,7 +15995,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Optional. The custom parameters to pass custom values to tracking URL template.", +"description": "Optional. The custom parameters and accompanying values to add to the tracking URL.", "type": "object" }, "descriptions": { @@ -16035,7 +16037,7 @@ false "description": "Required. The logo image used by this ad." }, "longHeadlines": { -"description": "Required. The list of lone headlines shown on the ad.", +"description": "Required. The list of long headlines shown on the ad.", "items": { "type": "string" }, @@ -18943,7 +18945,7 @@ false "additionalProperties": { "type": "string" }, -"description": "The custom parameters to pass custom values to tracking URL template.", +"description": "The custom parameters and accompanying values to add to the tracking URL.", "type": "object" } }, @@ -19394,7 +19396,7 @@ false "type": "object" }, "InventorySource": { -"description": "An inventory source. Next ID: 22", +"description": "An inventory source.", "id": "InventorySource", "properties": { "commitment": { @@ -20041,7 +20043,7 @@ false "id": "KeywordAssignedTargetingOptionDetails", "properties": { "exemptedPolicyNames": { -"description": "Optional. The policy names to exempt the keyword from. This field is only applicable for Demand Gen keywords, which are positively targeted.", +"description": "Optional. The policy names to exempt the keyword from. When attempting to target a keyword that violates a policy, the error returned will include the name of the relevant policy. Use that name in this field to exempt the targeted keyword from the policy. This field is only applicable for positively-targeted keywords assigned to Demand Gen resources. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.", "items": { "type": "string" }, @@ -20254,7 +20256,7 @@ false }, "frequencyCap": { "$ref": "FrequencyCap", -"description": "Optional. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. This field is REQUIRED for all line item types excluding LINE_ITEM_TYPE_DEMAND_GEN." +"description": "Optional. Required if the line item type is not `LINE_ITEM_TYPE_DEMAND_GEN`. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap." }, "insertionOrderId": { "description": "Required. Immutable. The unique ID of the insertion order that the line item belongs to.", @@ -20321,7 +20323,7 @@ false "YouTube video ads that aim to get more views with a variety of ad formats. Line items of this type and their targeting cannot be created or updated using the API.", "Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", "Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", -"Demand Gen ads." +"Demand Gen ads. Retrieval and management of Demand Gen resources is currently in beta. This enum value is only available to allowlisted users." ], "type": "string" }, @@ -20334,6 +20336,10 @@ false "readOnly": true, "type": "string" }, +"optimizeFixedBidding": { +"description": "Optional. Whether to enable DV360's bid optimization for fixed bid line items. By default, DV360 optimizes your fixed bid by automatically lowering bids for impressions that are less likely to perform well. This optimization is enabled by default (value is true). When this field is set to `false`, this optimization is disabled, and the bid will not be lowered for any reason. This setting only applies to line items with a `bidding_strategy` of type `FIXED_BID`.", +"type": "boolean" +}, "pacing": { "$ref": "Pacing", "description": "Required. The budget spending speed setting of the line item." @@ -20443,7 +20449,7 @@ false "id": "LineItemBudget", "properties": { "budgetAllocationType": { -"description": "Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. For demand gen line items, budget allocation type must be `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`. Demand Gen line items do not support other budget allocation types.", +"description": "Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. This field must be set to `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED` for Demand Gen line items.", "enum": [ "LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED", "LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC", @@ -21513,7 +21519,7 @@ false "additionalProperties": { "type": "string" }, -"description": "The custom parameters to pass custom values to tracking URL template.", +"description": "The custom parameters and accompanying values to add to the tracking URL.", "type": "object" } }, @@ -22148,7 +22154,7 @@ false "type": "string" }, "markupType": { -"description": "Required. The markup type of the partner revenue model. Demand Gen line items only support `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`.", +"description": "Required. The markup type of the partner revenue model. This field must be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP` for Demand Gen line items.", "enum": [ "PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED", "PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM", @@ -22990,7 +22996,7 @@ false "type": "boolean" }, "allowYoutubeStream": { -"description": "Whether the ad group is opted-in to YouTube in-stream.", +"description": "Whether the ad group is opted-in to YouTube in-stream inventory.", "type": "boolean" } }, @@ -23273,7 +23279,7 @@ false "type": "boolean" }, "excludeDemographicExpansion": { -"description": "Optional. Whether to exclude demographic expansion for Optimized Targeting. This field only applies to Demand Gen ad groups.", +"description": "Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently in beta. This field is only available to allowlisted users.", "type": "boolean" } }, @@ -23553,7 +23559,7 @@ false "type": "array" }, "brandSafetyVendorConfigs": { -"description": "Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_ZEFR`", +"description": "Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZEFR` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`", "items": { "$ref": "ThirdPartyVendorConfig" }, @@ -24139,7 +24145,7 @@ false "additionalProperties": { "type": "string" }, -"description": "The custom parameters to pass custom values to tracking URL template.", +"description": "The custom parameters and accompanying values to add to the tracking URL.", "type": "object" }, "descriptions": { @@ -24173,7 +24179,7 @@ false "type": "array" }, "longHeadlines": { -"description": "The list of lone headlines shown on the call-to-action banner.", +"description": "The list of long headlines shown on the call-to-action banner.", "items": { "type": "string" }, @@ -24445,7 +24451,7 @@ false "type": "string" }, "linkedMerchantId": { -"description": "Optional. The ID of the merchant which is linked to the line item for product feed.", +"description": "Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser.", "format": "int64", "type": "string" }, @@ -24726,7 +24732,7 @@ false "type": "string" }, "videoAssetId": { -"description": "Required. The YouTube video asset id. This is ad_asset.ad_asset_id.", +"description": "Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource.", "format": "int64", "type": "string" } From f46aeab2356832aee335c54d88606af152db68a3 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:41:00 +0000 Subject: [PATCH 16/32] feat(docs): update the api #### docs:v1 The following keys were added: - schemas.InsertRichLinkRequest (Total Keys: 5) - schemas.Request.properties.insertRichLink.$ref (Total Keys: 1) --- docs/dyn/docs_v1.documents.html | 212 ++++++++++-------- .../discovery_cache/documents/docs.v1.json | 29 ++- 2 files changed, 140 insertions(+), 101 deletions(-) diff --git a/docs/dyn/docs_v1.documents.html b/docs/dyn/docs_v1.documents.html index 9d2d0e8878..fa97032123 100644 --- a/docs/dyn/docs_v1.documents.html +++ b/docs/dyn/docs_v1.documents.html @@ -222,8 +222,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # Inserts the date at the end of the given header, footer or document body. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. @@ -283,6 +283,22 @@

Method Details

"name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. }, }, + "insertRichLink": { # Inserts a RichLink at the specified location. # Insert a rich link. + "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # Inserts the rich link at the end of a header, footer, footnote or the document body. + "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + }, + "location": { # A particular location in the document. # Inserts the rich link at a specific index in the document. The rich link must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). The rich link cannot be inserted inside an equation. + "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. + "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + }, + "richLinkProperties": { # Properties specific to a RichLink. # The properties of the rich link to insert. + "mimeType": "A String", # The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # The URI to the RichLink. This is always present. + }, + }, "insertSectionBreak": { # Inserts a section break at the given location. A newline character will be inserted before the section break. # Inserts a section break at the specified location. "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # Inserts a newline and a section break at the end of the document body. Section breaks cannot be inserted inside a footnote, header or footer. Because section breaks can only be inserted inside the body, the segment ID field must be empty. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. @@ -1298,8 +1314,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -1309,8 +1325,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -3453,8 +3469,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -3464,8 +3480,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -5548,8 +5564,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -5559,8 +5575,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -7643,8 +7659,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -7654,8 +7670,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -10917,8 +10933,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -10928,8 +10944,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -13071,8 +13087,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -13082,8 +13098,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -15166,8 +15182,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -15177,8 +15193,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -17261,8 +17277,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -17272,8 +17288,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -20550,8 +20566,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -20561,8 +20577,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -22705,8 +22721,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -22716,8 +22732,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -24800,8 +24816,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -24811,8 +24827,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -26895,8 +26911,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -26906,8 +26922,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -30169,8 +30185,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -30180,8 +30196,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -32323,8 +32339,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -32334,8 +32350,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -34418,8 +34434,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -34429,8 +34445,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -36513,8 +36529,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -36524,8 +36540,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -39816,8 +39832,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -39827,8 +39843,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -41971,8 +41987,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -41982,8 +41998,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -44066,8 +44082,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -44077,8 +44093,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -46161,8 +46177,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -46172,8 +46188,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -49435,8 +49451,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -49446,8 +49462,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -51589,8 +51605,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -51600,8 +51616,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -53684,8 +53700,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -53695,8 +53711,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. @@ -55779,8 +55795,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateId": "A String", # Output only. The unique ID of this date. "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. @@ -55790,8 +55806,8 @@

Method Details

"displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. }, "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. diff --git a/googleapiclient/discovery_cache/documents/docs.v1.json b/googleapiclient/discovery_cache/documents/docs.v1.json index 6fc60fd70a..8bdef730ae 100644 --- a/googleapiclient/discovery_cache/documents/docs.v1.json +++ b/googleapiclient/discovery_cache/documents/docs.v1.json @@ -221,7 +221,7 @@ } } }, -"revision": "20260323", +"revision": "20260408", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AddDocumentTabRequest": { @@ -792,11 +792,11 @@ "type": "string" }, "timeZoneId": { -"description": "The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New York`. If unset, the default time zone is `etc/UTC`.", +"description": "The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`.", "type": "string" }, "timestamp": { -"description": "The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_8SO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`.", +"description": "The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`.", "format": "google-datetime", "type": "string" } @@ -1984,6 +1984,25 @@ }, "type": "object" }, +"InsertRichLinkRequest": { +"description": "Inserts a RichLink at the specified location.", +"id": "InsertRichLinkRequest", +"properties": { +"endOfSegmentLocation": { +"$ref": "EndOfSegmentLocation", +"description": "Inserts the rich link at the end of a header, footer, footnote or the document body." +}, +"location": { +"$ref": "Location", +"description": "Inserts the rich link at a specific index in the document. The rich link must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). The rich link cannot be inserted inside an equation." +}, +"richLinkProperties": { +"$ref": "RichLinkProperties", +"description": "The properties of the rich link to insert." +} +}, +"type": "object" +}, "InsertSectionBreakRequest": { "description": "Inserts a section break at the given location. A newline character will be inserted before the section break.", "id": "InsertSectionBreakRequest", @@ -3326,6 +3345,10 @@ "$ref": "InsertPersonRequest", "description": "Inserts a person mention." }, +"insertRichLink": { +"$ref": "InsertRichLinkRequest", +"description": "Insert a rich link." +}, "insertSectionBreak": { "$ref": "InsertSectionBreakRequest", "description": "Inserts a section break at the specified location." From ef9fc3ef46e6cf444f57f7c5099a0c9cc02f772e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:41:00 +0000 Subject: [PATCH 17/32] feat(drive): update the api #### drive:v2 The following keys were added: - resources.files.methods.generateCseToken (Total Keys: 11) - schemas.ClientEncryptionDetails (Total Keys: 4) - schemas.DecryptionMetadata (Total Keys: 10) - schemas.File.properties.clientEncryptionDetails.$ref (Total Keys: 1) - schemas.GenerateCseTokenResponse (Total Keys: 8) #### drive:v3 The following keys were added: - resources.files.methods.generateCseToken (Total Keys: 11) - schemas.ClientEncryptionDetails (Total Keys: 4) - schemas.DecryptionMetadata (Total Keys: 10) - schemas.File.properties.clientEncryptionDetails.$ref (Total Keys: 1) - schemas.GenerateCseTokenResponse (Total Keys: 8) --- docs/dyn/drive_v2.changes.html | 24 +++ docs/dyn/drive_v2.files.html | 183 ++++++++++++++++++ docs/dyn/drive_v3.changes.html | 14 +- docs/dyn/drive_v3.files.html | 139 ++++++++++++- .../discovery_cache/documents/drive.v2.json | 111 ++++++++++- .../discovery_cache/documents/drive.v3.json | 113 ++++++++++- 6 files changed, 572 insertions(+), 12 deletions(-) diff --git a/docs/dyn/drive_v2.changes.html b/docs/dyn/drive_v2.changes.html index acfe364df2..96d14f154e 100644 --- a/docs/dyn/drive_v2.changes.html +++ b/docs/dyn/drive_v2.changes.html @@ -216,6 +216,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. @@ -760,6 +772,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. diff --git a/docs/dyn/drive_v2.files.html b/docs/dyn/drive_v2.files.html index 612a915087..0041c5a4c5 100644 --- a/docs/dyn/drive_v2.files.html +++ b/docs/dyn/drive_v2.files.html @@ -92,6 +92,9 @@

Instance Methods

export_media(fileId, mimeType, x__xgafv=None)

Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.

+

+ generateCseToken(fileId=None, parent=None, x__xgafv=None)

+

Generates a CSE token which can be used to create or update CSE files.

generateIds(maxResults=None, space=None, type=None, x__xgafv=None)

Generates a set of file IDs which can be provided in insert or copy requests.

@@ -202,6 +205,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. @@ -610,6 +625,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. @@ -1004,6 +1031,30 @@

Method Details

+
+ generateCseToken(fileId=None, parent=None, x__xgafv=None) +
Generates a CSE token which can be used to create or update CSE files.
+
+Args:
+  fileId: string, The ID of the file for which the JWT should be generated. If not provided, an id will be generated.
+  parent: string, The ID of the expected parent of the file. Used when generating a JWT for a new CSE file. If specified, the parent will be fetched, and if the parent is a shared drive item, the shared drive's policy will be used to determine the KACLS that should be used. It is invalid to specify both file_id and parent in a single request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # JWT and associated metadata used to generate CSE files.
+  "currentKaclsId": "A String", # The current Key ACL Service (KACLS) ID associated with the JWT.
+  "currentKaclsName": "A String", # Name of the KACLs that the returned KACLs ID points to.
+  "fileId": "A String", # The fileId for which the JWT was generated.
+  "jwt": "A String", # The signed JSON Web Token (JWT) for the file.
+  "kind": "A String", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#generateCseTokenResponse"`.
+}
+
+
generateIds(maxResults=None, space=None, type=None, x__xgafv=None)
Generates a set of file IDs which can be provided in insert or copy requests.
@@ -1104,6 +1155,18 @@ 

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. @@ -1526,6 +1589,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. @@ -1937,6 +2012,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. @@ -2362,6 +2449,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. @@ -2944,6 +3043,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. @@ -3362,6 +3473,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. @@ -3766,6 +3889,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. @@ -4170,6 +4305,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. @@ -4574,6 +4721,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. @@ -4969,6 +5128,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. @@ -5389,6 +5560,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentRestrictions": [ # Restrictions for accessing the content of the file. Only populated if such a restriction exists. { # A restriction for accessing the content of the file. "ownerRestricted": True or False, # Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with `organizer` capabilities can modify or remove this content restriction. diff --git a/docs/dyn/drive_v3.changes.html b/docs/dyn/drive_v3.changes.html index 8fcac1428d..b095e2148e 100644 --- a/docs/dyn/drive_v3.changes.html +++ b/docs/dyn/drive_v3.changes.html @@ -252,6 +252,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentHints": { # Additional information about the content of the file. These fields are never populated in responses. "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail. @@ -472,7 +484,7 @@

Method Details

"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead. "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. + "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, but other users can still access the file in the owner's trash until it's permanently deleted. "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. "displayName": "A String", # Output only. A plain text displayable name for this user. diff --git a/docs/dyn/drive_v3.files.html b/docs/dyn/drive_v3.files.html index ea7539994f..6eda3f7468 100644 --- a/docs/dyn/drive_v3.files.html +++ b/docs/dyn/drive_v3.files.html @@ -98,6 +98,9 @@

Instance Methods

export_media(fileId, mimeType, x__xgafv=None)

Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see [Download and export files](https://developers.google.com/workspace/drive/api/guides/manage-downloads). Note that the exported content is limited to 10 MB.

+

+ generateCseToken(fileId=None, parent=None, x__xgafv=None)

+

Generates a CSE token which can be used to create or update CSE files.

generateIds(count=None, space=None, type=None, x__xgafv=None)

Generates a set of file IDs which can be provided in create or copy requests. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).

@@ -194,6 +197,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentHints": { # Additional information about the content of the file. These fields are never populated in responses. "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail. @@ -414,7 +429,7 @@

Method Details

"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead. "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. + "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, but other users can still access the file in the owner's trash until it's permanently deleted. "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. "displayName": "A String", # Output only. A plain text displayable name for this user. @@ -505,6 +520,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentHints": { # Additional information about the content of the file. These fields are never populated in responses. "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail. @@ -725,7 +752,7 @@

Method Details

"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead. "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. + "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, but other users can still access the file in the owner's trash until it's permanently deleted. "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. "displayName": "A String", # Output only. A plain text displayable name for this user. @@ -809,6 +836,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentHints": { # Additional information about the content of the file. These fields are never populated in responses. "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail. @@ -1029,7 +1068,7 @@

Method Details

"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead. "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. + "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, but other users can still access the file in the owner's trash until it's permanently deleted. "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. "displayName": "A String", # Output only. A plain text displayable name for this user. @@ -1123,6 +1162,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentHints": { # Additional information about the content of the file. These fields are never populated in responses. "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail. @@ -1343,7 +1394,7 @@

Method Details

"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead. "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. + "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, but other users can still access the file in the owner's trash until it's permanently deleted. "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. "displayName": "A String", # Output only. A plain text displayable name for this user. @@ -1463,6 +1514,30 @@

Method Details

+
+ generateCseToken(fileId=None, parent=None, x__xgafv=None) +
Generates a CSE token which can be used to create or update CSE files.
+
+Args:
+  fileId: string, The ID of the file for which the JWT should be generated. If not provided, an id will be generated.
+  parent: string, The ID of the expected parent of the file. Used when generating a JWT for a new CSE file. If specified, the parent will be fetched, and if the parent is a shared drive item, the shared drive's policy will be used to determine the KACLS that should be used. It is invalid to specify both file_id and parent in a single request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # JWT and associated metadata used to generate CSE files.
+  "currentKaclsId": "A String", # The current Key ACL Service (KACLS) ID associated with the JWT.
+  "currentKaclsName": "A String", # Name of the KACLs that the returned KACLs ID points to.
+  "fileId": "A String", # The fileId for which the JWT was generated.
+  "jwt": "A String", # The signed JSON Web Token (JWT) for the file.
+  "kind": "A String", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#generateCseTokenResponse"`.
+}
+
+
generateIds(count=None, space=None, type=None, x__xgafv=None)
Generates a set of file IDs which can be provided in create or copy requests. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).
@@ -1558,6 +1633,18 @@ 

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentHints": { # Additional information about the content of the file. These fields are never populated in responses. "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail. @@ -1778,7 +1865,7 @@

Method Details

"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead. "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. + "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, but other users can still access the file in the owner's trash until it's permanently deleted. "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. "displayName": "A String", # Output only. A plain text displayable name for this user. @@ -1909,6 +1996,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentHints": { # Additional information about the content of the file. These fields are never populated in responses. "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail. @@ -2129,7 +2228,7 @@

Method Details

"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead. "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. + "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, but other users can still access the file in the owner's trash until it's permanently deleted. "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. "displayName": "A String", # Output only. A plain text displayable name for this user. @@ -2396,6 +2495,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentHints": { # Additional information about the content of the file. These fields are never populated in responses. "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail. @@ -2616,7 +2727,7 @@

Method Details

"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead. "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. + "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, but other users can still access the file in the owner's trash until it's permanently deleted. "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. "displayName": "A String", # Output only. A plain text displayable name for this user. @@ -2711,6 +2822,18 @@

Method Details

"canTrashChildren": True or False, # Output only. Whether the current user can trash children of this folder. This is `false` when the item isn't a folder. Only populated for items in shared drives. "canUntrash": True or False, # Output only. Whether the current user can restore this file from trash. }, + "clientEncryptionDetails": { # Details about the client-side encryption applied to the file. # Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts. + "decryptionMetadata": { # Representation of the CSE DecryptionMetadata. # The metadata used for client-side operations. + "aes256GcmChunkSize": "A String", # Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small + "encryptionResourceKeyHash": "A String", # The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference + "jwt": "A String", # The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file. + "kaclsId": "A String", # The ID of the KACLS (Key ACL Service) used to encrypt the file. + "kaclsName": "A String", # The name of the KACLS (Key ACL Service) used to encrypt the file. + "keyFormat": "A String", # Key format for the unwrapped key. Must be `tinkAesGcmKey`. + "wrappedKey": "A String", # The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file. + }, + "encryptionState": "A String", # The encryption state of the file. The values expected here are: - encrypted - unencrypted + }, "contentHints": { # Additional information about the content of the file. These fields are never populated in responses. "indexableText": "A String", # Text to be indexed for the file to improve fullText queries. This is limited to 128 KB in length and may contain HTML elements. "thumbnail": { # A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail. @@ -2931,7 +3054,7 @@

Method Details

"teamDriveId": "A String", # Deprecated: Output only. Use `driveId` instead. "thumbnailLink": "A String", # Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies. Consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `files.thumbnailLink` must be fetched using a credentialed request. "thumbnailVersion": "A String", # Output only. The thumbnail version for use in thumbnail cache invalidation. - "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. + "trashed": True or False, # Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, but other users can still access the file in the owner's trash until it's permanently deleted. "trashedTime": "A String", # The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. "trashingUser": { # Information about a Drive user. # Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. "displayName": "A String", # Output only. A plain text displayable name for this user. diff --git a/googleapiclient/discovery_cache/documents/drive.v2.json b/googleapiclient/discovery_cache/documents/drive.v2.json index 371d770949..87660bed26 100644 --- a/googleapiclient/discovery_cache/documents/drive.v2.json +++ b/googleapiclient/discovery_cache/documents/drive.v2.json @@ -1445,6 +1445,32 @@ "supportsMediaDownload": true, "useMediaDownloadService": true }, +"generateCseToken": { +"description": "Generates a CSE token which can be used to create or update CSE files.", +"flatPath": "files/generateCseToken", +"httpMethod": "GET", +"id": "drive.files.generateCseToken", +"parameterOrder": [], +"parameters": { +"fileId": { +"description": "The ID of the file for which the JWT should be generated. If not provided, an id will be generated.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "The ID of the expected parent of the file. Used when generating a JWT for a new CSE file. If specified, the parent will be fetched, and if the parent is a shared drive item, the shared drive's policy will be used to determine the KACLS that should be used. It is invalid to specify both file_id and parent in a single request.", +"location": "query", +"type": "string" +} +}, +"path": "files/generateCseToken", +"response": { +"$ref": "GenerateCseTokenResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/drive" +] +}, "generateIds": { "description": "Generates a set of file IDs which can be provided in insert or copy requests.", "flatPath": "files/generateIds", @@ -3897,7 +3923,7 @@ } } }, -"revision": "20260322", +"revision": "20260405", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -4565,6 +4591,21 @@ }, "type": "object" }, +"ClientEncryptionDetails": { +"description": "Details about the client-side encryption applied to the file.", +"id": "ClientEncryptionDetails", +"properties": { +"decryptionMetadata": { +"$ref": "DecryptionMetadata", +"description": "The metadata used for client-side operations." +}, +"encryptionState": { +"description": "The encryption state of the file. The values expected here are: - encrypted - unencrypted ", +"type": "string" +} +}, +"type": "object" +}, "Comment": { "description": "A comment on a file in Google Drive.", "id": "Comment", @@ -4805,6 +4846,42 @@ }, "type": "object" }, +"DecryptionMetadata": { +"description": "Representation of the CSE DecryptionMetadata.", +"id": "DecryptionMetadata", +"properties": { +"aes256GcmChunkSize": { +"description": "Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small ", +"type": "string" +}, +"encryptionResourceKeyHash": { +"description": "The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference", +"type": "string" +}, +"jwt": { +"description": "The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file.", +"type": "string" +}, +"kaclsId": { +"description": "The ID of the KACLS (Key ACL Service) used to encrypt the file.", +"format": "int64", +"type": "string" +}, +"kaclsName": { +"description": "The name of the KACLS (Key ACL Service) used to encrypt the file.", +"type": "string" +}, +"keyFormat": { +"description": "Key format for the unwrapped key. Must be `tinkAesGcmKey`.", +"type": "string" +}, +"wrappedKey": { +"description": "The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file.", +"type": "string" +} +}, +"type": "object" +}, "Drive": { "description": "Representation of a shared drive. Some resource methods (such as `drives.update`) require a `driveId`. Use the `drives.list` method to retrieve the ID for a shared drive.", "id": "Drive", @@ -5226,6 +5303,10 @@ }, "type": "object" }, +"clientEncryptionDetails": { +"$ref": "ClientEncryptionDetails", +"description": "Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts." +}, "contentRestrictions": { "description": "Restrictions for accessing the content of the file. Only populated if such a restriction exists.", "items": { @@ -5807,6 +5888,34 @@ }, "type": "object" }, +"GenerateCseTokenResponse": { +"description": "JWT and associated metadata used to generate CSE files.", +"id": "GenerateCseTokenResponse", +"properties": { +"currentKaclsId": { +"description": "The current Key ACL Service (KACLS) ID associated with the JWT.", +"format": "int64", +"type": "string" +}, +"currentKaclsName": { +"description": "Name of the KACLs that the returned KACLs ID points to.", +"type": "string" +}, +"fileId": { +"description": "The fileId for which the JWT was generated.", +"type": "string" +}, +"jwt": { +"description": "The signed JSON Web Token (JWT) for the file.", +"type": "string" +}, +"kind": { +"description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#generateCseTokenResponse\"`.", +"type": "string" +} +}, +"type": "object" +}, "GeneratedIds": { "description": "A list of generated IDs which can be provided in insert requests", "id": "GeneratedIds", diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json index d3d23026d8..066228fb16 100644 --- a/googleapiclient/discovery_cache/documents/drive.v3.json +++ b/googleapiclient/discovery_cache/documents/drive.v3.json @@ -1431,6 +1431,32 @@ "supportsMediaDownload": true, "useMediaDownloadService": true }, +"generateCseToken": { +"description": "Generates a CSE token which can be used to create or update CSE files.", +"flatPath": "files/generateCseToken", +"httpMethod": "GET", +"id": "drive.files.generateCseToken", +"parameterOrder": [], +"parameters": { +"fileId": { +"description": "The ID of the file for which the JWT should be generated. If not provided, an id will be generated.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "The ID of the expected parent of the file. Used when generating a JWT for a new CSE file. If specified, the parent will be fetched, and if the parent is a shared drive item, the shared drive's policy will be used to determine the KACLS that should be used. It is invalid to specify both file_id and parent in a single request.", +"location": "query", +"type": "string" +} +}, +"path": "files/generateCseToken", +"response": { +"$ref": "GenerateCseTokenResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/drive" +] +}, "generateIds": { "description": "Generates a set of file IDs which can be provided in create or copy requests. For more information, see [Create and manage files](https://developers.google.com/workspace/drive/api/guides/create-file).", "flatPath": "files/generateIds", @@ -2803,7 +2829,7 @@ } } }, -"revision": "20260322", +"revision": "20260405", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -3398,6 +3424,21 @@ }, "type": "object" }, +"ClientEncryptionDetails": { +"description": "Details about the client-side encryption applied to the file.", +"id": "ClientEncryptionDetails", +"properties": { +"decryptionMetadata": { +"$ref": "DecryptionMetadata", +"description": "The metadata used for client-side operations." +}, +"encryptionState": { +"description": "The encryption state of the file. The values expected here are: - encrypted - unencrypted ", +"type": "string" +} +}, +"type": "object" +}, "Comment": { "description": "A comment on a file. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file.", "id": "Comment", @@ -3547,6 +3588,42 @@ }, "type": "object" }, +"DecryptionMetadata": { +"description": "Representation of the CSE DecryptionMetadata.", +"id": "DecryptionMetadata", +"properties": { +"aes256GcmChunkSize": { +"description": "Chunk size used if content was encrypted with the AES 256 GCM Cipher. Possible values are: - default - small ", +"type": "string" +}, +"encryptionResourceKeyHash": { +"description": "The URL-safe Base64 encoded HMAC-SHA256 digest of the resource metadata with its DEK (Data Encryption Key); see https://developers.google.com/workspace/cse/reference", +"type": "string" +}, +"jwt": { +"description": "The signed JSON Web Token (JWT) which can be used to authorize the requesting user with the Key ACL Service (KACLS). The JWT asserts that the requesting user has at least read permissions on the file.", +"type": "string" +}, +"kaclsId": { +"description": "The ID of the KACLS (Key ACL Service) used to encrypt the file.", +"format": "int64", +"type": "string" +}, +"kaclsName": { +"description": "The name of the KACLS (Key ACL Service) used to encrypt the file.", +"type": "string" +}, +"keyFormat": { +"description": "Key format for the unwrapped key. Must be `tinkAesGcmKey`.", +"type": "string" +}, +"wrappedKey": { +"description": "The URL-safe Base64 encoded wrapped key used to encrypt the contents of the file.", +"type": "string" +} +}, +"type": "object" +}, "DownloadRestriction": { "description": "A restriction for copy and download of the file.", "id": "DownloadRestriction", @@ -3992,6 +4069,10 @@ }, "type": "object" }, +"clientEncryptionDetails": { +"$ref": "ClientEncryptionDetails", +"description": "Client Side Encryption related details. Contains details about the encryption state of the file and details regarding the encryption mechanism that clients need to use when decrypting the contents of this item. This will only be present on files and not on folders or shortcuts." +}, "contentHints": { "description": "Additional information about the content of the file. These fields are never populated in responses.", "properties": { @@ -4398,7 +4479,7 @@ "type": "string" }, "trashed": { -"description": "Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.", +"description": "Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, but other users can still access the file in the owner's trash until it's permanently deleted.", "type": "boolean" }, "trashedTime": { @@ -4492,6 +4573,34 @@ }, "type": "object" }, +"GenerateCseTokenResponse": { +"description": "JWT and associated metadata used to generate CSE files.", +"id": "GenerateCseTokenResponse", +"properties": { +"currentKaclsId": { +"description": "The current Key ACL Service (KACLS) ID associated with the JWT.", +"format": "int64", +"type": "string" +}, +"currentKaclsName": { +"description": "Name of the KACLs that the returned KACLs ID points to.", +"type": "string" +}, +"fileId": { +"description": "The fileId for which the JWT was generated.", +"type": "string" +}, +"jwt": { +"description": "The signed JSON Web Token (JWT) for the file.", +"type": "string" +}, +"kind": { +"description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#generateCseTokenResponse\"`.", +"type": "string" +} +}, +"type": "object" +}, "GeneratedIds": { "description": "A list of generated file IDs which can be provided in create requests.", "id": "GeneratedIds", From 500de5b2fbffc06637921e9aa495b96018412223 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:41:00 +0000 Subject: [PATCH 18/32] feat(firebaseappcheck): update the api #### firebaseappcheck:v1 The following keys were added: - schemas.GoogleFirebaseAppcheckV1Service.properties.replayProtection.type (Total Keys: 1) - schemas.GoogleFirebaseAppcheckV1Service.properties.updateTime (Total Keys: 3) #### firebaseappcheck:v1beta The following keys were added: - schemas.GoogleFirebaseAppcheckV1betaService.properties.replayProtection.type (Total Keys: 1) --- ...appcheck_v1.projects.apps.debugTokens.html | 11 ++++-- ...firebaseappcheck_v1.projects.services.html | 18 ++++++++++ ...heck_v1beta.projects.apps.debugTokens.html | 11 ++++-- ...baseappcheck_v1beta.projects.services.html | 6 ++++ .../documents/firebaseappcheck.v1.json | 35 ++++++++++++++++++- .../documents/firebaseappcheck.v1beta.json | 25 ++++++++++++- 6 files changed, 100 insertions(+), 6 deletions(-) diff --git a/docs/dyn/firebaseappcheck_v1.projects.apps.debugTokens.html b/docs/dyn/firebaseappcheck_v1.projects.apps.debugTokens.html index 9c3ffaa3e6..3660ba2d34 100644 --- a/docs/dyn/firebaseappcheck_v1.projects.apps.debugTokens.html +++ b/docs/dyn/firebaseappcheck_v1.projects.apps.debugTokens.html @@ -81,7 +81,7 @@

Instance Methods

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

Creates a new DebugToken for the specified app. For security reasons, after the creation operation completes, the `token` field cannot be updated or retrieved, but you can revoke the debug token using DeleteDebugToken. Each app can have a maximum of 20 debug tokens.

- delete(name, x__xgafv=None)

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

Deletes the specified DebugToken. A deleted debug token cannot be used to exchange for an App Check token. Use this method when you suspect the secret `token` has been compromised or when you no longer need the debug token.

get(name, x__xgafv=None)

@@ -112,6 +112,7 @@

Method Details

{ # A *debug token* is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services. "displayName": "A String", # Required. A human readable display name used to identify this debug token. + "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. @@ -127,6 +128,7 @@

Method Details

{ # A *debug token* is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services. "displayName": "A String", # Required. A human readable display name used to identify this debug token. + "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. @@ -134,11 +136,12 @@

Method Details

- delete(name, x__xgafv=None) + delete(name, etag=None, x__xgafv=None)
Deletes the specified DebugToken. A deleted debug token cannot be used to exchange for an App Check token. Use this method when you suspect the secret `token` has been compromised or when you no longer need the debug token.
 
 Args:
   name: string, Required. The relative resource name of the DebugToken to delete, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` (required)
+  etag: string, Optional. The checksum to be validated against the current DebugToken, to ensure the client has an up-to-date value before proceeding. This checksum is computed by the server based on the values of fields in the DebugToken object, and can be obtained from the DebugToken object received from the last CreateDebugToken, GetDebugToken, ListDebugTokens, or UpdateDebugToken call. This etag is strongly validated as defined by RFC 7232.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -167,6 +170,7 @@ 

Method Details

{ # A *debug token* is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services. "displayName": "A String", # Required. A human readable display name used to identify this debug token. + "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. @@ -193,6 +197,7 @@

Method Details

"debugTokens": [ # The DebugTokens retrieved. { # A *debug token* is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services. "displayName": "A String", # Required. A human readable display name used to identify this debug token. + "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. @@ -227,6 +232,7 @@

Method Details

{ # A *debug token* is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services. "displayName": "A String", # Required. A human readable display name used to identify this debug token. + "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. @@ -243,6 +249,7 @@

Method Details

{ # A *debug token* is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services. "displayName": "A String", # Required. A human readable display name used to identify this debug token. + "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. diff --git a/docs/dyn/firebaseappcheck_v1.projects.services.html b/docs/dyn/firebaseappcheck_v1.projects.services.html index 4e379859be..29a27a87c3 100644 --- a/docs/dyn/firebaseappcheck_v1.projects.services.html +++ b/docs/dyn/firebaseappcheck_v1.projects.services.html @@ -112,7 +112,10 @@

Method Details

{ # Request message for the UpdateService method as well as an individual update message for the BatchUpdateServices method. "service": { # The enforcement configuration for a Firebase service supported by App Check. # Required. The Service to update. The Service's `name` field is used to identify the Service to be updated, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS) "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. + "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS) + "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. + "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. }, "updateMask": "A String", # Required. A comma-separated list of names of fields in the Service to update. Example: `enforcement_mode`. }, @@ -132,7 +135,10 @@

Method Details

"services": [ # Service objects after the updates have been applied. { # The enforcement configuration for a Firebase service supported by App Check. "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. + "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS) + "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. + "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. }, ], }
@@ -159,7 +165,10 @@

Method Details

{ # The enforcement configuration for a Firebase service supported by App Check. "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. + "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS) + "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. + "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. }
@@ -184,7 +193,10 @@

Method Details

"services": [ # The Services retrieved. { # The enforcement configuration for a Firebase service supported by App Check. "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. + "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS) + "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. + "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. }, ], }
@@ -215,7 +227,10 @@

Method Details

{ # The enforcement configuration for a Firebase service supported by App Check. "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. + "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS) + "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. + "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. } updateMask: string, Required. A comma-separated list of names of fields in the Service to update. Example: `enforcement_mode`. @@ -229,7 +244,10 @@

Method Details

{ # The enforcement configuration for a Firebase service supported by App Check. "enforcementMode": "A String", # Required. The App Check enforcement mode for this service. + "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS) + "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. + "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. }
diff --git a/docs/dyn/firebaseappcheck_v1beta.projects.apps.debugTokens.html b/docs/dyn/firebaseappcheck_v1beta.projects.apps.debugTokens.html index 984005db69..742dde5392 100644 --- a/docs/dyn/firebaseappcheck_v1beta.projects.apps.debugTokens.html +++ b/docs/dyn/firebaseappcheck_v1beta.projects.apps.debugTokens.html @@ -81,7 +81,7 @@

Instance Methods

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

Creates a new DebugToken for the specified app. For security reasons, after the creation operation completes, the `token` field cannot be updated or retrieved, but you can revoke the debug token using DeleteDebugToken. Each app can have a maximum of 20 debug tokens.

- delete(name, x__xgafv=None)

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

Deletes the specified DebugToken. A deleted debug token cannot be used to exchange for an App Check token. Use this method when you suspect the secret `token` has been compromised or when you no longer need the debug token.

get(name, x__xgafv=None)

@@ -112,6 +112,7 @@

Method Details

{ # A *debug token* is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services. "displayName": "A String", # Required. A human readable display name used to identify this debug token. + "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. @@ -127,6 +128,7 @@

Method Details

{ # A *debug token* is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services. "displayName": "A String", # Required. A human readable display name used to identify this debug token. + "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. @@ -134,11 +136,12 @@

Method Details

- delete(name, x__xgafv=None) + delete(name, etag=None, x__xgafv=None)
Deletes the specified DebugToken. A deleted debug token cannot be used to exchange for an App Check token. Use this method when you suspect the secret `token` has been compromised or when you no longer need the debug token.
 
 Args:
   name: string, Required. The relative resource name of the DebugToken to delete, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` (required)
+  etag: string, Optional. The checksum to be validated against the current DebugToken, to ensure the client has an up-to-date value before proceeding. This checksum is computed by the server based on the values of fields in the DebugToken object, and can be obtained from the DebugToken object received from the last CreateDebugToken, GetDebugToken, ListDebugTokens, or UpdateDebugToken call. This etag is strongly validated as defined by RFC 7232.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -167,6 +170,7 @@ 

Method Details

{ # A *debug token* is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services. "displayName": "A String", # Required. A human readable display name used to identify this debug token. + "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. @@ -193,6 +197,7 @@

Method Details

"debugTokens": [ # The DebugTokens retrieved. { # A *debug token* is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services. "displayName": "A String", # Required. A human readable display name used to identify this debug token. + "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. @@ -227,6 +232,7 @@

Method Details

{ # A *debug token* is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services. "displayName": "A String", # Required. A human readable display name used to identify this debug token. + "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. @@ -243,6 +249,7 @@

Method Details

{ # A *debug token* is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services. "displayName": "A String", # Required. A human readable display name used to identify this debug token. + "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ``` "token": "A String", # Required. Input only. Immutable. The secret token itself. Must be provided during creation, and must be a UUID4, case insensitive. This field is immutable once set, and cannot be provided during an UpdateDebugToken request. You can, however, delete this debug token using DeleteDebugToken to revoke it. For security reasons, this field will never be populated in any response. "updateTime": "A String", # Output only. Timestamp when this debug token was most recently updated. diff --git a/docs/dyn/firebaseappcheck_v1beta.projects.services.html b/docs/dyn/firebaseappcheck_v1beta.projects.services.html index dc0bec1b23..b4529ebd31 100644 --- a/docs/dyn/firebaseappcheck_v1beta.projects.services.html +++ b/docs/dyn/firebaseappcheck_v1beta.projects.services.html @@ -114,6 +114,7 @@

Method Details

"enforcementMode": "A String", # Required. The App Check enforcement mode for this service. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS) + "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. }, "updateMask": "A String", # Required. A comma-separated list of names of fields in the Service to update. Example: `enforcement_mode`. @@ -136,6 +137,7 @@

Method Details

"enforcementMode": "A String", # Required. The App Check enforcement mode for this service. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS) + "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. }, ], @@ -165,6 +167,7 @@

Method Details

"enforcementMode": "A String", # Required. The App Check enforcement mode for this service. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS) + "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. }
@@ -192,6 +195,7 @@

Method Details

"enforcementMode": "A String", # Required. The App Check enforcement mode for this service. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS) + "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. }, ], @@ -225,6 +229,7 @@

Method Details

"enforcementMode": "A String", # Required. The App Check enforcement mode for this service. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS) + "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. } @@ -241,6 +246,7 @@

Method Details

"enforcementMode": "A String", # Required. The App Check enforcement mode for this service. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. "name": "A String", # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS) + "replayProtection": "A String", # Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`. "updateTime": "A String", # Output only. Timestamp when this service configuration object was most recently updated. }
diff --git a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json index b77c4cadac..6dc71d3c1a 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json @@ -721,6 +721,11 @@ "name" ], "parameters": { +"etag": { +"description": "Optional. The checksum to be validated against the current DebugToken, to ensure the client has an up-to-date value before proceeding. This checksum is computed by the server based on the values of fields in the DebugToken object, and can be obtained from the DebugToken object received from the last CreateDebugToken, GetDebugToken, ListDebugTokens, or UpdateDebugToken call. This etag is strongly validated as defined by RFC 7232.", +"location": "query", +"type": "string" +}, "name": { "description": "Required. The relative resource name of the DebugToken to delete, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ```", "location": "path", @@ -1661,7 +1666,7 @@ } } }, -"revision": "20260207", +"revision": "20260403", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1AppAttestConfig": { @@ -1855,6 +1860,10 @@ "description": "Required. A human readable display name used to identify this debug token.", "type": "string" }, +"etag": { +"description": "Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232.", +"type": "string" +}, "name": { "description": "Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ```", "type": "string" @@ -2430,9 +2439,33 @@ ], "type": "string" }, +"etag": { +"description": "Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232.", +"type": "string" +}, "name": { "description": "Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS)", "type": "string" +}, +"replayProtection": { +"description": "Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`.", +"enum": [ +"OFF", +"UNENFORCED", +"ENFORCED" +], +"enumDescriptions": [ +"The relevant App Check protection is not enforced for the service or resource, nor are App Check metrics collected. Though the relevant App Check protection is not applied, other applicable protections, such as user authorization, are still enforced. An unconfigured protection is in this mode by default.", +"The relevant App Check protection is not enforced for the service or resource. App Check metrics are collected to help you decide when to turn on enforcement. These metrics will show the portion of traffic that is deemed invalid by the relevant App Check protection, but that traffic will not be rejected until you turn on enforcement. Though the relevant App Check protection is not enforced, other applicable protections, such as user authorization, are still enforced. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.", +"The relevant App Check protection is enforced for the service or resource. The service or resource will reject any traffic not accompanied by an App Check token that is deemded valid by the relevant protection. There are some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check protections. If your users have not updated to a version of your app that meets the requirements of the relevant App Check protection, their app may stop working. App Check metrics can help you decide whether to enforce App Check on your services and resources. If your app has not launched yet, you should enable enforcement as soon as you verify that your App Check implementation is correct, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service." +], +"type": "string" +}, +"updateTime": { +"description": "Output only. Timestamp when this service configuration object was most recently updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json index b8c5c28930..77a33a0839 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json @@ -782,6 +782,11 @@ "name" ], "parameters": { +"etag": { +"description": "Optional. The checksum to be validated against the current DebugToken, to ensure the client has an up-to-date value before proceeding. This checksum is computed by the server based on the values of fields in the DebugToken object, and can be obtained from the DebugToken object received from the last CreateDebugToken, GetDebugToken, ListDebugTokens, or UpdateDebugToken call. This etag is strongly validated as defined by RFC 7232.", +"location": "query", +"type": "string" +}, "name": { "description": "Required. The relative resource name of the DebugToken to delete, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ```", "location": "path", @@ -1823,7 +1828,7 @@ } } }, -"revision": "20260207", +"revision": "20260403", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1betaAppAttestConfig": { @@ -2054,6 +2059,10 @@ "description": "Required. A human readable display name used to identify this debug token.", "type": "string" }, +"etag": { +"description": "Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232.", +"type": "string" +}, "name": { "description": "Required. The relative resource name of the debug token, in the format: ``` projects/{project_number}/apps/{app_id}/debugTokens/{debug_token_id} ```", "type": "string" @@ -2689,6 +2698,20 @@ "description": "Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS)", "type": "string" }, +"replayProtection": { +"description": "Optional. The replay protection enforcement mode for this service. Note that this field cannot be set to a level higher than the overall App Check enforcement mode. For example, if the overall App Check enforcement mode is set to `UNENFORCED`, this field cannot be set to `ENFORCED`. In order to enforce replay protection, you must first enforce App Check. An HTTP 400 error will be returned in this case. By default, this field is set to `OFF`. Setting this field to `UNENFORCED` or `ENFORCED` is considered opting into replay protection. Once opted in, requests to your protected services may experience higher latency. To opt out of replay protection after opting in, set this field to `OFF`.", +"enum": [ +"OFF", +"UNENFORCED", +"ENFORCED" +], +"enumDescriptions": [ +"The relevant App Check protection is not enforced for the service or resource, nor are App Check metrics collected. Though the relevant App Check protection is not applied, other applicable protections, such as user authorization, are still enforced. An unconfigured protection is in this mode by default.", +"The relevant App Check protection is not enforced for the service or resource. App Check metrics are collected to help you decide when to turn on enforcement. These metrics will show the portion of traffic that is deemed invalid by the relevant App Check protection, but that traffic will not be rejected until you turn on enforcement. Though the relevant App Check protection is not enforced, other applicable protections, such as user authorization, are still enforced. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.", +"The relevant App Check protection is enforced for the service or resource. The service or resource will reject any traffic not accompanied by an App Check token that is deemded valid by the relevant protection. There are some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check protections. If your users have not updated to a version of your app that meets the requirements of the relevant App Check protection, their app may stop working. App Check metrics can help you decide whether to enforce App Check on your services and resources. If your app has not launched yet, you should enable enforcement as soon as you verify that your App Check implementation is correct, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service." +], +"type": "string" +}, "updateTime": { "description": "Output only. Timestamp when this service configuration object was most recently updated.", "format": "google-datetime", From 16f14b237a3ce2bc47f8167483cf125a94f59c0d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:41:00 +0000 Subject: [PATCH 19/32] feat(firebaseappdistribution): update the api #### firebaseappdistribution:v1 The following keys were added: - schemas.GdataContentTypeInfo.properties.fromFusionId.type (Total Keys: 1) - schemas.GdataContentTypeInfo.properties.fusionIdDetectionMetadata (Total Keys: 2) --- docs/dyn/firebaseappdistribution_v1.media.html | 2 ++ .../documents/firebaseappdistribution.v1.json | 11 ++++++++++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/dyn/firebaseappdistribution_v1.media.html b/docs/dyn/firebaseappdistribution_v1.media.html index 2afc2a6941..8bdb9e36bb 100644 --- a/docs/dyn/firebaseappdistribution_v1.media.html +++ b/docs/dyn/firebaseappdistribution_v1.media.html @@ -141,8 +141,10 @@

Method Details

"bestGuess": "A String", # Scotty's best guess of what the content type of the file is. "fromBytes": "A String", # The content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file. "fromFileName": "A String", # The content type of the file derived from the file extension of the original file name used by the client. + "fromFusionId": "A String", # The content type of the file detected by Fusion ID. go/fusionid "fromHeader": "A String", # The content type of the file as specified in the request headers, multipart headers, or RUPIO start request. "fromUrlPath": "A String", # The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API). + "fusionIdDetectionMetadata": "A String", # Metadata information from Fusion ID detection. Serialized FusionIdDetectionMetadata proto. Only set if from_fusion_id is set. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. "crc32cHash": 42, # For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported. diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json index baafeb3cd9..f34415b76c 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json @@ -946,7 +946,7 @@ } } }, -"revision": "20260113", +"revision": "20260408", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -1078,6 +1078,10 @@ "description": "The content type of the file derived from the file extension of the original file name used by the client.", "type": "string" }, +"fromFusionId": { +"description": "The content type of the file detected by Fusion ID. go/fusionid", +"type": "string" +}, "fromHeader": { "description": "The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.", "type": "string" @@ -1085,6 +1089,11 @@ "fromUrlPath": { "description": "The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).", "type": "string" +}, +"fusionIdDetectionMetadata": { +"description": "Metadata information from Fusion ID detection. Serialized FusionIdDetectionMetadata proto. Only set if from_fusion_id is set.", +"format": "byte", +"type": "string" } }, "type": "object" From 9b92f7f97ae7b274bc68a3fc0e1beb6ca913b20a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:41:01 +0000 Subject: [PATCH 20/32] feat(firestore): update the api #### firestore:v1 The following keys were deleted: - schemas.GoogleFirestoreAdminV1SearchConfig.properties.numberSpec.$ref (Total Keys: 1) - schemas.GoogleFirestoreAdminV1SearchIndexOptions.properties.customPartitionFieldPaths (Total Keys: 2) - schemas.GoogleFirestoreAdminV1SearchNumberSpec (Total Keys: 3) --- ...cts.databases.collectionGroups.fields.html | 18 ------- ...ts.databases.collectionGroups.indexes.html | 18 ------- .../documents/firestore.v1.json | 54 ++----------------- 3 files changed, 5 insertions(+), 85 deletions(-) diff --git a/docs/dyn/firestore_v1.projects.databases.collectionGroups.fields.html b/docs/dyn/firestore_v1.projects.databases.collectionGroups.fields.html index e4902deeb2..81dd63dff8 100644 --- a/docs/dyn/firestore_v1.projects.databases.collectionGroups.fields.html +++ b/docs/dyn/firestore_v1.projects.databases.collectionGroups.fields.html @@ -125,9 +125,6 @@

Method Details

"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. @@ -148,9 +145,6 @@

Method Details

"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. }, @@ -205,9 +199,6 @@

Method Details

"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. @@ -228,9 +219,6 @@

Method Details

"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. }, @@ -292,9 +280,6 @@

Method Details

"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. @@ -315,9 +300,6 @@

Method Details

"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. }, diff --git a/docs/dyn/firestore_v1.projects.databases.collectionGroups.indexes.html b/docs/dyn/firestore_v1.projects.databases.collectionGroups.indexes.html index 6d062abe74..2285bb83db 100644 --- a/docs/dyn/firestore_v1.projects.databases.collectionGroups.indexes.html +++ b/docs/dyn/firestore_v1.projects.databases.collectionGroups.indexes.html @@ -119,9 +119,6 @@

Method Details

"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. @@ -142,9 +139,6 @@

Method Details

"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. }, @@ -226,9 +220,6 @@

Method Details

"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. @@ -249,9 +240,6 @@

Method Details

"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. }, @@ -292,9 +280,6 @@

Method Details

"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. @@ -315,9 +300,6 @@

Method Details

"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. }, diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json index dad0f570fb..14aab57d02 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1.json @@ -2435,7 +2435,7 @@ } } }, -"revision": "20260327", +"revision": "20260405", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -4620,10 +4620,6 @@ "$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." @@ -4646,13 +4642,6 @@ "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" @@ -4664,33 +4653,6 @@ }, "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", @@ -4699,15 +4661,11 @@ "description": "Required. How to index the text field value.", "enum": [ "TEXT_INDEX_TYPE_UNSPECIFIED", -"TOKENIZED", -"NGRAMS", -"EXACT_MATCH" +"TOKENIZED" ], "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." +"Field values are tokenized. This is the only way currently supported for MONGODB_COMPATIBLE_API." ], "type": "string" }, @@ -4715,13 +4673,11 @@ "description": "Required. How to match the text field value.", "enum": [ "TEXT_MATCH_TYPE_UNSPECIFIED", -"MATCH_GLOBALLY", -"MATCH_FIELD" +"MATCH_GLOBALLY" ], "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." +"Match on any indexed field. This is the only way currently supported for MONGODB_COMPATIBLE_API." ], "type": "string" } From 4663180ab425229fcb238a4840aef56e913b5c89 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:41:01 +0000 Subject: [PATCH 21/32] feat(gkehub): update the api #### gkehub:v1alpha The following keys were added: - schemas.RolloutSequence.properties.ignoredClustersSelector.$ref (Total Keys: 1) #### gkehub:v1beta The following keys were added: - schemas.RolloutSequence.properties.ignoredClustersSelector.$ref (Total Keys: 1) --- ..._v1alpha.projects.locations.rolloutSequences.html | 12 ++++++++++++ ...b_v1beta.projects.locations.rolloutSequences.html | 12 ++++++++++++ .../discovery_cache/documents/gkehub.v1alpha.json | 6 +++++- .../discovery_cache/documents/gkehub.v1beta.json | 6 +++++- 4 files changed, 34 insertions(+), 2 deletions(-) diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.rolloutSequences.html b/docs/dyn/gkehub_v1alpha.projects.locations.rolloutSequences.html index a1b16c086c..b84102288e 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.rolloutSequences.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.rolloutSequences.html @@ -115,6 +115,9 @@

Method Details

"deleteTime": "A String", # Output only. The timestamp at the Rollout Sequence was deleted. "displayName": "A String", # Optional. Human readable display name of the Rollout Sequence. "etag": "A String", # Output only. etag of the Rollout Sequence Ex. abc1234 + "ignoredClustersSelector": { # Selector for clusters. # Optional. Selector for clusters to exclude from the Rollout Sequence. + "labelSelector": "A String", # Required. A valid CEL (Common Expression Language) expression which evaluates `resource.labels`. + }, "labels": { # Optional. Labels for this Rollout Sequence. "a_key": "A String", }, @@ -225,6 +228,9 @@

Method Details

"deleteTime": "A String", # Output only. The timestamp at the Rollout Sequence was deleted. "displayName": "A String", # Optional. Human readable display name of the Rollout Sequence. "etag": "A String", # Output only. etag of the Rollout Sequence Ex. abc1234 + "ignoredClustersSelector": { # Selector for clusters. # Optional. Selector for clusters to exclude from the Rollout Sequence. + "labelSelector": "A String", # Required. A valid CEL (Common Expression Language) expression which evaluates `resource.labels`. + }, "labels": { # Optional. Labels for this Rollout Sequence. "a_key": "A String", }, @@ -277,6 +283,9 @@

Method Details

"deleteTime": "A String", # Output only. The timestamp at the Rollout Sequence was deleted. "displayName": "A String", # Optional. Human readable display name of the Rollout Sequence. "etag": "A String", # Output only. etag of the Rollout Sequence Ex. abc1234 + "ignoredClustersSelector": { # Selector for clusters. # Optional. Selector for clusters to exclude from the Rollout Sequence. + "labelSelector": "A String", # Required. A valid CEL (Common Expression Language) expression which evaluates `resource.labels`. + }, "labels": { # Optional. Labels for this Rollout Sequence. "a_key": "A String", }, @@ -334,6 +343,9 @@

Method Details

"deleteTime": "A String", # Output only. The timestamp at the Rollout Sequence was deleted. "displayName": "A String", # Optional. Human readable display name of the Rollout Sequence. "etag": "A String", # Output only. etag of the Rollout Sequence Ex. abc1234 + "ignoredClustersSelector": { # Selector for clusters. # Optional. Selector for clusters to exclude from the Rollout Sequence. + "labelSelector": "A String", # Required. A valid CEL (Common Expression Language) expression which evaluates `resource.labels`. + }, "labels": { # Optional. Labels for this Rollout Sequence. "a_key": "A String", }, diff --git a/docs/dyn/gkehub_v1beta.projects.locations.rolloutSequences.html b/docs/dyn/gkehub_v1beta.projects.locations.rolloutSequences.html index 727c26b469..8bfec5603a 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.rolloutSequences.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.rolloutSequences.html @@ -115,6 +115,9 @@

Method Details

"deleteTime": "A String", # Output only. The timestamp at the Rollout Sequence was deleted. "displayName": "A String", # Optional. Human readable display name of the Rollout Sequence. "etag": "A String", # Output only. etag of the Rollout Sequence Ex. abc1234 + "ignoredClustersSelector": { # Selector for clusters. # Optional. Selector for clusters to exclude from the Rollout Sequence. + "labelSelector": "A String", # Required. A valid CEL (Common Expression Language) expression which evaluates `resource.labels`. + }, "labels": { # Optional. Labels for this Rollout Sequence. "a_key": "A String", }, @@ -225,6 +228,9 @@

Method Details

"deleteTime": "A String", # Output only. The timestamp at the Rollout Sequence was deleted. "displayName": "A String", # Optional. Human readable display name of the Rollout Sequence. "etag": "A String", # Output only. etag of the Rollout Sequence Ex. abc1234 + "ignoredClustersSelector": { # Selector for clusters. # Optional. Selector for clusters to exclude from the Rollout Sequence. + "labelSelector": "A String", # Required. A valid CEL (Common Expression Language) expression which evaluates `resource.labels`. + }, "labels": { # Optional. Labels for this Rollout Sequence. "a_key": "A String", }, @@ -277,6 +283,9 @@

Method Details

"deleteTime": "A String", # Output only. The timestamp at the Rollout Sequence was deleted. "displayName": "A String", # Optional. Human readable display name of the Rollout Sequence. "etag": "A String", # Output only. etag of the Rollout Sequence Ex. abc1234 + "ignoredClustersSelector": { # Selector for clusters. # Optional. Selector for clusters to exclude from the Rollout Sequence. + "labelSelector": "A String", # Required. A valid CEL (Common Expression Language) expression which evaluates `resource.labels`. + }, "labels": { # Optional. Labels for this Rollout Sequence. "a_key": "A String", }, @@ -334,6 +343,9 @@

Method Details

"deleteTime": "A String", # Output only. The timestamp at the Rollout Sequence was deleted. "displayName": "A String", # Optional. Human readable display name of the Rollout Sequence. "etag": "A String", # Output only. etag of the Rollout Sequence Ex. abc1234 + "ignoredClustersSelector": { # Selector for clusters. # Optional. Selector for clusters to exclude from the Rollout Sequence. + "labelSelector": "A String", # Required. A valid CEL (Common Expression Language) expression which evaluates `resource.labels`. + }, "labels": { # Optional. Labels for this Rollout Sequence. "a_key": "A String", }, diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index 60a7795597..2db820ba44 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -2510,7 +2510,7 @@ } } }, -"revision": "20260324", +"revision": "20260405", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -7138,6 +7138,10 @@ "readOnly": true, "type": "string" }, +"ignoredClustersSelector": { +"$ref": "ClusterSelector", +"description": "Optional. Selector for clusters to exclude from the Rollout Sequence." +}, "labels": { "additionalProperties": { "type": "string" diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index 6343e27a1f..cbc218f4bd 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -2366,7 +2366,7 @@ } } }, -"revision": "20260324", +"revision": "20260405", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -6747,6 +6747,10 @@ "readOnly": true, "type": "string" }, +"ignoredClustersSelector": { +"$ref": "ClusterSelector", +"description": "Optional. Selector for clusters to exclude from the Rollout Sequence." +}, "labels": { "additionalProperties": { "type": "string" From 5d98f5d84eb4c95c8ea20bbef21a17b6cc608c86 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:41:01 +0000 Subject: [PATCH 22/32] feat(hypercomputecluster): update the api #### hypercomputecluster:v1 The following keys were added: - schemas.NetworkResource.properties.network.readOnly (Total Keys: 1) - schemas.StorageResource.properties.bucket.readOnly (Total Keys: 1) - schemas.StorageResource.properties.filestore.readOnly (Total Keys: 1) - schemas.StorageResource.properties.lustre.readOnly (Total Keys: 1) --- ...luster_v1.projects.locations.clusters.html | 48 +++++++++---------- .../documents/hypercomputecluster.v1.json | 18 ++++--- 2 files changed, 35 insertions(+), 31 deletions(-) diff --git a/docs/dyn/hypercomputecluster_v1.projects.locations.clusters.html b/docs/dyn/hypercomputecluster_v1.projects.locations.clusters.html index d94860649f..d155dc8155 100644 --- a/docs/dyn/hypercomputecluster_v1.projects.locations.clusters.html +++ b/docs/dyn/hypercomputecluster_v1.projects.locations.clusters.html @@ -140,7 +140,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. [Relative resource name](https://google.aip.dev/122) of the cluster, in the format `projects/{project}/locations/{location}/clusters/{cluster}`. - "networkResources": { # Optional. Network resources available to the cluster. Must contain at most one value. Keys specify the ID of the network resource by which it can be referenced elsewhere, and must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters). + "networkResources": { # Optional. Network resources available to the cluster. Must contain exactly one value. Keys specify the ID of the network resource by which it can be referenced elsewhere, and must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters). "a_key": { # A resource representing a network that connects the various components of a cluster together. "config": { # Describes how a network resource should be initialized. Each network resource can either be imported from an existing Google Cloud resource or initialized when the cluster is created. # Immutable. Configuration for this network resource, which describes how it should be created or imported. This field only controls how the network resource is initially created or imported. Subsequent changes to the network resource should be made via the resource's API and will not be reflected in the configuration. "existingNetwork": { # When set in a NetworkResourceConfig, indicates that an existing network should be imported. # Optional. Immutable. If set, indicates that an existing network should be imported. @@ -152,7 +152,7 @@

Method Details

"network": "A String", # Required. Immutable. Name of the network to create, in the format `projects/{project}/global/networks/{network}`. }, }, - "network": { # A reference to a [VPC network](https://cloud.google.com/vpc/docs/vpc) in Google Compute Engine. # Reference to a network in Google Compute Engine. + "network": { # A reference to a [VPC network](https://cloud.google.com/vpc/docs/vpc) in Google Compute Engine. # Output only. Reference to a network in Google Compute Engine. "network": "A String", # Output only. Name of the network, in the format `projects/{project}/global/networks/{network}`. "subnetwork": "A String", # Output only. Name of the particular subnetwork being used by the cluster, in the format `projects/{project}/regions/{region}/subnetworks/{subnetwork}`. }, @@ -192,7 +192,7 @@

Method Details

}, "nodeSets": [ # Optional. Compute resource configuration for the Slurm nodesets in your cluster. If not specified, the cluster won't create any nodes. { # Configuration for Slurm nodesets in the cluster. Nodesets are groups of compute nodes used by Slurm that are responsible for running workloads submitted to the cluster. - "computeId": "A String", # Optional. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's compute_resources. + "computeId": "A String", # Required. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's compute_resources. "computeInstance": { # When set in a SlurmNodeSet, indicates that the nodeset should be backed by Compute Engine VM instances. # Optional. If set, indicates that the nodeset should be backed by Compute Engine instances. "bootDisk": { # A [Persistent disk](https://cloud.google.com/compute/docs/disks) used as the boot disk for a Compute Engine VM instance. # Optional. Boot disk for the compute instance "sizeGb": "A String", # Required. Immutable. Size of the disk in gigabytes. Must be at least 10GB. @@ -230,7 +230,7 @@

Method Details

"reconciling": True or False, # Output only. Indicates whether changes to the cluster are currently in flight. If this is `true`, then the current state might not match the cluster's intended state. "storageResources": { # Optional. Storage resources available to the cluster. Keys specify the ID of the storage resource by which it can be referenced elsewhere, and must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters). "a_key": { # A resource representing a form of persistent storage that is accessible to compute resources in the cluster. - "bucket": { # A reference to a [Google Cloud Storage](https://cloud.google.com/storage) bucket. # Reference to a Google Cloud Storage bucket. Populated if and only if the storage resource was configured to use Google Cloud Storage. + "bucket": { # A reference to a [Google Cloud Storage](https://cloud.google.com/storage) bucket. # Output only. Reference to a Google Cloud Storage bucket. Populated if and only if the storage resource was configured to use Google Cloud Storage. "bucket": "A String", # Output only. Name of the bucket. }, "config": { # Describes how a storage resource should be initialized. Each storage resource can either be imported from an existing Google Cloud resource or initialized when the cluster is created. # Required. Immutable. Configuration for this storage resource, which describes how it should be created or imported. This field only controls how the storage resource is initially created or imported. Subsequent changes to the storage resource should be made via the resource's API and will not be reflected in the configuration. @@ -273,10 +273,10 @@

Method Details

"lustre": "A String", # Required. Immutable. Name of the Managed Lustre instance to create, in the format `projects/{project}/locations/{location}/instances/{instance}` }, }, - "filestore": { # A reference to a [Filestore](https://cloud.google.com/filestore) instance. # Reference to a Filestore instance. Populated if and only if the storage resource was configured to use Filestore. + "filestore": { # A reference to a [Filestore](https://cloud.google.com/filestore) instance. # Output only. Reference to a Filestore instance. Populated if and only if the storage resource was configured to use Filestore. "filestore": "A String", # Output only. Name of the Filestore instance, in the format `projects/{project}/locations/{location}/instances/{instance}` }, - "lustre": { # A reference to a [Managed Lustre](https://cloud.google.com/products/managed-lustre) instance. # Reference to a Managed Lustre instance. Populated if and only if the storage resource was configured to use Managed Lustre. + "lustre": { # A reference to a [Managed Lustre](https://cloud.google.com/products/managed-lustre) instance. # Output only. Reference to a Managed Lustre instance. Populated if and only if the storage resource was configured to use Managed Lustre. "lustre": "A String", # Output only. Name of the Managed Lustre instance, in the format `projects/{project}/locations/{location}/instances/{instance}` }, }, @@ -395,7 +395,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. [Relative resource name](https://google.aip.dev/122) of the cluster, in the format `projects/{project}/locations/{location}/clusters/{cluster}`. - "networkResources": { # Optional. Network resources available to the cluster. Must contain at most one value. Keys specify the ID of the network resource by which it can be referenced elsewhere, and must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters). + "networkResources": { # Optional. Network resources available to the cluster. Must contain exactly one value. Keys specify the ID of the network resource by which it can be referenced elsewhere, and must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters). "a_key": { # A resource representing a network that connects the various components of a cluster together. "config": { # Describes how a network resource should be initialized. Each network resource can either be imported from an existing Google Cloud resource or initialized when the cluster is created. # Immutable. Configuration for this network resource, which describes how it should be created or imported. This field only controls how the network resource is initially created or imported. Subsequent changes to the network resource should be made via the resource's API and will not be reflected in the configuration. "existingNetwork": { # When set in a NetworkResourceConfig, indicates that an existing network should be imported. # Optional. Immutable. If set, indicates that an existing network should be imported. @@ -407,7 +407,7 @@

Method Details

"network": "A String", # Required. Immutable. Name of the network to create, in the format `projects/{project}/global/networks/{network}`. }, }, - "network": { # A reference to a [VPC network](https://cloud.google.com/vpc/docs/vpc) in Google Compute Engine. # Reference to a network in Google Compute Engine. + "network": { # A reference to a [VPC network](https://cloud.google.com/vpc/docs/vpc) in Google Compute Engine. # Output only. Reference to a network in Google Compute Engine. "network": "A String", # Output only. Name of the network, in the format `projects/{project}/global/networks/{network}`. "subnetwork": "A String", # Output only. Name of the particular subnetwork being used by the cluster, in the format `projects/{project}/regions/{region}/subnetworks/{subnetwork}`. }, @@ -447,7 +447,7 @@

Method Details

}, "nodeSets": [ # Optional. Compute resource configuration for the Slurm nodesets in your cluster. If not specified, the cluster won't create any nodes. { # Configuration for Slurm nodesets in the cluster. Nodesets are groups of compute nodes used by Slurm that are responsible for running workloads submitted to the cluster. - "computeId": "A String", # Optional. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's compute_resources. + "computeId": "A String", # Required. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's compute_resources. "computeInstance": { # When set in a SlurmNodeSet, indicates that the nodeset should be backed by Compute Engine VM instances. # Optional. If set, indicates that the nodeset should be backed by Compute Engine instances. "bootDisk": { # A [Persistent disk](https://cloud.google.com/compute/docs/disks) used as the boot disk for a Compute Engine VM instance. # Optional. Boot disk for the compute instance "sizeGb": "A String", # Required. Immutable. Size of the disk in gigabytes. Must be at least 10GB. @@ -485,7 +485,7 @@

Method Details

"reconciling": True or False, # Output only. Indicates whether changes to the cluster are currently in flight. If this is `true`, then the current state might not match the cluster's intended state. "storageResources": { # Optional. Storage resources available to the cluster. Keys specify the ID of the storage resource by which it can be referenced elsewhere, and must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters). "a_key": { # A resource representing a form of persistent storage that is accessible to compute resources in the cluster. - "bucket": { # A reference to a [Google Cloud Storage](https://cloud.google.com/storage) bucket. # Reference to a Google Cloud Storage bucket. Populated if and only if the storage resource was configured to use Google Cloud Storage. + "bucket": { # A reference to a [Google Cloud Storage](https://cloud.google.com/storage) bucket. # Output only. Reference to a Google Cloud Storage bucket. Populated if and only if the storage resource was configured to use Google Cloud Storage. "bucket": "A String", # Output only. Name of the bucket. }, "config": { # Describes how a storage resource should be initialized. Each storage resource can either be imported from an existing Google Cloud resource or initialized when the cluster is created. # Required. Immutable. Configuration for this storage resource, which describes how it should be created or imported. This field only controls how the storage resource is initially created or imported. Subsequent changes to the storage resource should be made via the resource's API and will not be reflected in the configuration. @@ -528,10 +528,10 @@

Method Details

"lustre": "A String", # Required. Immutable. Name of the Managed Lustre instance to create, in the format `projects/{project}/locations/{location}/instances/{instance}` }, }, - "filestore": { # A reference to a [Filestore](https://cloud.google.com/filestore) instance. # Reference to a Filestore instance. Populated if and only if the storage resource was configured to use Filestore. + "filestore": { # A reference to a [Filestore](https://cloud.google.com/filestore) instance. # Output only. Reference to a Filestore instance. Populated if and only if the storage resource was configured to use Filestore. "filestore": "A String", # Output only. Name of the Filestore instance, in the format `projects/{project}/locations/{location}/instances/{instance}` }, - "lustre": { # A reference to a [Managed Lustre](https://cloud.google.com/products/managed-lustre) instance. # Reference to a Managed Lustre instance. Populated if and only if the storage resource was configured to use Managed Lustre. + "lustre": { # A reference to a [Managed Lustre](https://cloud.google.com/products/managed-lustre) instance. # Output only. Reference to a Managed Lustre instance. Populated if and only if the storage resource was configured to use Managed Lustre. "lustre": "A String", # Output only. Name of the Managed Lustre instance, in the format `projects/{project}/locations/{location}/instances/{instance}` }, }, @@ -590,7 +590,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. [Relative resource name](https://google.aip.dev/122) of the cluster, in the format `projects/{project}/locations/{location}/clusters/{cluster}`. - "networkResources": { # Optional. Network resources available to the cluster. Must contain at most one value. Keys specify the ID of the network resource by which it can be referenced elsewhere, and must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters). + "networkResources": { # Optional. Network resources available to the cluster. Must contain exactly one value. Keys specify the ID of the network resource by which it can be referenced elsewhere, and must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters). "a_key": { # A resource representing a network that connects the various components of a cluster together. "config": { # Describes how a network resource should be initialized. Each network resource can either be imported from an existing Google Cloud resource or initialized when the cluster is created. # Immutable. Configuration for this network resource, which describes how it should be created or imported. This field only controls how the network resource is initially created or imported. Subsequent changes to the network resource should be made via the resource's API and will not be reflected in the configuration. "existingNetwork": { # When set in a NetworkResourceConfig, indicates that an existing network should be imported. # Optional. Immutable. If set, indicates that an existing network should be imported. @@ -602,7 +602,7 @@

Method Details

"network": "A String", # Required. Immutable. Name of the network to create, in the format `projects/{project}/global/networks/{network}`. }, }, - "network": { # A reference to a [VPC network](https://cloud.google.com/vpc/docs/vpc) in Google Compute Engine. # Reference to a network in Google Compute Engine. + "network": { # A reference to a [VPC network](https://cloud.google.com/vpc/docs/vpc) in Google Compute Engine. # Output only. Reference to a network in Google Compute Engine. "network": "A String", # Output only. Name of the network, in the format `projects/{project}/global/networks/{network}`. "subnetwork": "A String", # Output only. Name of the particular subnetwork being used by the cluster, in the format `projects/{project}/regions/{region}/subnetworks/{subnetwork}`. }, @@ -642,7 +642,7 @@

Method Details

}, "nodeSets": [ # Optional. Compute resource configuration for the Slurm nodesets in your cluster. If not specified, the cluster won't create any nodes. { # Configuration for Slurm nodesets in the cluster. Nodesets are groups of compute nodes used by Slurm that are responsible for running workloads submitted to the cluster. - "computeId": "A String", # Optional. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's compute_resources. + "computeId": "A String", # Required. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's compute_resources. "computeInstance": { # When set in a SlurmNodeSet, indicates that the nodeset should be backed by Compute Engine VM instances. # Optional. If set, indicates that the nodeset should be backed by Compute Engine instances. "bootDisk": { # A [Persistent disk](https://cloud.google.com/compute/docs/disks) used as the boot disk for a Compute Engine VM instance. # Optional. Boot disk for the compute instance "sizeGb": "A String", # Required. Immutable. Size of the disk in gigabytes. Must be at least 10GB. @@ -680,7 +680,7 @@

Method Details

"reconciling": True or False, # Output only. Indicates whether changes to the cluster are currently in flight. If this is `true`, then the current state might not match the cluster's intended state. "storageResources": { # Optional. Storage resources available to the cluster. Keys specify the ID of the storage resource by which it can be referenced elsewhere, and must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters). "a_key": { # A resource representing a form of persistent storage that is accessible to compute resources in the cluster. - "bucket": { # A reference to a [Google Cloud Storage](https://cloud.google.com/storage) bucket. # Reference to a Google Cloud Storage bucket. Populated if and only if the storage resource was configured to use Google Cloud Storage. + "bucket": { # A reference to a [Google Cloud Storage](https://cloud.google.com/storage) bucket. # Output only. Reference to a Google Cloud Storage bucket. Populated if and only if the storage resource was configured to use Google Cloud Storage. "bucket": "A String", # Output only. Name of the bucket. }, "config": { # Describes how a storage resource should be initialized. Each storage resource can either be imported from an existing Google Cloud resource or initialized when the cluster is created. # Required. Immutable. Configuration for this storage resource, which describes how it should be created or imported. This field only controls how the storage resource is initially created or imported. Subsequent changes to the storage resource should be made via the resource's API and will not be reflected in the configuration. @@ -723,10 +723,10 @@

Method Details

"lustre": "A String", # Required. Immutable. Name of the Managed Lustre instance to create, in the format `projects/{project}/locations/{location}/instances/{instance}` }, }, - "filestore": { # A reference to a [Filestore](https://cloud.google.com/filestore) instance. # Reference to a Filestore instance. Populated if and only if the storage resource was configured to use Filestore. + "filestore": { # A reference to a [Filestore](https://cloud.google.com/filestore) instance. # Output only. Reference to a Filestore instance. Populated if and only if the storage resource was configured to use Filestore. "filestore": "A String", # Output only. Name of the Filestore instance, in the format `projects/{project}/locations/{location}/instances/{instance}` }, - "lustre": { # A reference to a [Managed Lustre](https://cloud.google.com/products/managed-lustre) instance. # Reference to a Managed Lustre instance. Populated if and only if the storage resource was configured to use Managed Lustre. + "lustre": { # A reference to a [Managed Lustre](https://cloud.google.com/products/managed-lustre) instance. # Output only. Reference to a Managed Lustre instance. Populated if and only if the storage resource was configured to use Managed Lustre. "lustre": "A String", # Output only. Name of the Managed Lustre instance, in the format `projects/{project}/locations/{location}/instances/{instance}` }, }, @@ -794,7 +794,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. [Relative resource name](https://google.aip.dev/122) of the cluster, in the format `projects/{project}/locations/{location}/clusters/{cluster}`. - "networkResources": { # Optional. Network resources available to the cluster. Must contain at most one value. Keys specify the ID of the network resource by which it can be referenced elsewhere, and must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters). + "networkResources": { # Optional. Network resources available to the cluster. Must contain exactly one value. Keys specify the ID of the network resource by which it can be referenced elsewhere, and must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters). "a_key": { # A resource representing a network that connects the various components of a cluster together. "config": { # Describes how a network resource should be initialized. Each network resource can either be imported from an existing Google Cloud resource or initialized when the cluster is created. # Immutable. Configuration for this network resource, which describes how it should be created or imported. This field only controls how the network resource is initially created or imported. Subsequent changes to the network resource should be made via the resource's API and will not be reflected in the configuration. "existingNetwork": { # When set in a NetworkResourceConfig, indicates that an existing network should be imported. # Optional. Immutable. If set, indicates that an existing network should be imported. @@ -806,7 +806,7 @@

Method Details

"network": "A String", # Required. Immutable. Name of the network to create, in the format `projects/{project}/global/networks/{network}`. }, }, - "network": { # A reference to a [VPC network](https://cloud.google.com/vpc/docs/vpc) in Google Compute Engine. # Reference to a network in Google Compute Engine. + "network": { # A reference to a [VPC network](https://cloud.google.com/vpc/docs/vpc) in Google Compute Engine. # Output only. Reference to a network in Google Compute Engine. "network": "A String", # Output only. Name of the network, in the format `projects/{project}/global/networks/{network}`. "subnetwork": "A String", # Output only. Name of the particular subnetwork being used by the cluster, in the format `projects/{project}/regions/{region}/subnetworks/{subnetwork}`. }, @@ -846,7 +846,7 @@

Method Details

}, "nodeSets": [ # Optional. Compute resource configuration for the Slurm nodesets in your cluster. If not specified, the cluster won't create any nodes. { # Configuration for Slurm nodesets in the cluster. Nodesets are groups of compute nodes used by Slurm that are responsible for running workloads submitted to the cluster. - "computeId": "A String", # Optional. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's compute_resources. + "computeId": "A String", # Required. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's compute_resources. "computeInstance": { # When set in a SlurmNodeSet, indicates that the nodeset should be backed by Compute Engine VM instances. # Optional. If set, indicates that the nodeset should be backed by Compute Engine instances. "bootDisk": { # A [Persistent disk](https://cloud.google.com/compute/docs/disks) used as the boot disk for a Compute Engine VM instance. # Optional. Boot disk for the compute instance "sizeGb": "A String", # Required. Immutable. Size of the disk in gigabytes. Must be at least 10GB. @@ -884,7 +884,7 @@

Method Details

"reconciling": True or False, # Output only. Indicates whether changes to the cluster are currently in flight. If this is `true`, then the current state might not match the cluster's intended state. "storageResources": { # Optional. Storage resources available to the cluster. Keys specify the ID of the storage resource by which it can be referenced elsewhere, and must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters). "a_key": { # A resource representing a form of persistent storage that is accessible to compute resources in the cluster. - "bucket": { # A reference to a [Google Cloud Storage](https://cloud.google.com/storage) bucket. # Reference to a Google Cloud Storage bucket. Populated if and only if the storage resource was configured to use Google Cloud Storage. + "bucket": { # A reference to a [Google Cloud Storage](https://cloud.google.com/storage) bucket. # Output only. Reference to a Google Cloud Storage bucket. Populated if and only if the storage resource was configured to use Google Cloud Storage. "bucket": "A String", # Output only. Name of the bucket. }, "config": { # Describes how a storage resource should be initialized. Each storage resource can either be imported from an existing Google Cloud resource or initialized when the cluster is created. # Required. Immutable. Configuration for this storage resource, which describes how it should be created or imported. This field only controls how the storage resource is initially created or imported. Subsequent changes to the storage resource should be made via the resource's API and will not be reflected in the configuration. @@ -927,10 +927,10 @@

Method Details

"lustre": "A String", # Required. Immutable. Name of the Managed Lustre instance to create, in the format `projects/{project}/locations/{location}/instances/{instance}` }, }, - "filestore": { # A reference to a [Filestore](https://cloud.google.com/filestore) instance. # Reference to a Filestore instance. Populated if and only if the storage resource was configured to use Filestore. + "filestore": { # A reference to a [Filestore](https://cloud.google.com/filestore) instance. # Output only. Reference to a Filestore instance. Populated if and only if the storage resource was configured to use Filestore. "filestore": "A String", # Output only. Name of the Filestore instance, in the format `projects/{project}/locations/{location}/instances/{instance}` }, - "lustre": { # A reference to a [Managed Lustre](https://cloud.google.com/products/managed-lustre) instance. # Reference to a Managed Lustre instance. Populated if and only if the storage resource was configured to use Managed Lustre. + "lustre": { # A reference to a [Managed Lustre](https://cloud.google.com/products/managed-lustre) instance. # Output only. Reference to a Managed Lustre instance. Populated if and only if the storage resource was configured to use Managed Lustre. "lustre": "A String", # Output only. Name of the Managed Lustre instance, in the format `projects/{project}/locations/{location}/instances/{instance}` }, }, diff --git a/googleapiclient/discovery_cache/documents/hypercomputecluster.v1.json b/googleapiclient/discovery_cache/documents/hypercomputecluster.v1.json index e0e565bedf..6f3112e2b6 100644 --- a/googleapiclient/discovery_cache/documents/hypercomputecluster.v1.json +++ b/googleapiclient/discovery_cache/documents/hypercomputecluster.v1.json @@ -498,7 +498,7 @@ } } }, -"revision": "20260325", +"revision": "20260401", "rootUrl": "https://hypercomputecluster.googleapis.com/", "schemas": { "BootDisk": { @@ -577,7 +577,7 @@ "additionalProperties": { "$ref": "NetworkResource" }, -"description": "Optional. Network resources available to the cluster. Must contain at most one value. Keys specify the ID of the network resource by which it can be referenced elsewhere, and must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters).", +"description": "Optional. Network resources available to the cluster. Must contain exactly one value. Keys specify the ID of the network resource by which it can be referenced elsewhere, and must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters).", "type": "object" }, "orchestrator": { @@ -1120,7 +1120,8 @@ }, "network": { "$ref": "NetworkReference", -"description": "Reference to a network in Google Compute Engine." +"description": "Output only. Reference to a network in Google Compute Engine.", +"readOnly": true } }, "type": "object" @@ -1648,7 +1649,7 @@ "id": "SlurmNodeSet", "properties": { "computeId": { -"description": "Optional. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's compute_resources.", +"description": "Required. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's compute_resources.", "type": "string" }, "computeInstance": { @@ -1788,7 +1789,8 @@ "properties": { "bucket": { "$ref": "BucketReference", -"description": "Reference to a Google Cloud Storage bucket. Populated if and only if the storage resource was configured to use Google Cloud Storage." +"description": "Output only. Reference to a Google Cloud Storage bucket. Populated if and only if the storage resource was configured to use Google Cloud Storage.", +"readOnly": true }, "config": { "$ref": "StorageResourceConfig", @@ -1796,11 +1798,13 @@ }, "filestore": { "$ref": "FilestoreReference", -"description": "Reference to a Filestore instance. Populated if and only if the storage resource was configured to use Filestore." +"description": "Output only. Reference to a Filestore instance. Populated if and only if the storage resource was configured to use Filestore.", +"readOnly": true }, "lustre": { "$ref": "LustreReference", -"description": "Reference to a Managed Lustre instance. Populated if and only if the storage resource was configured to use Managed Lustre." +"description": "Output only. Reference to a Managed Lustre instance. Populated if and only if the storage resource was configured to use Managed Lustre.", +"readOnly": true } }, "type": "object" From aee6413c96bb6866eb5384ee4e627154be3c843e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:41:01 +0000 Subject: [PATCH 23/32] feat(merchantapi): update the api #### merchantapi:inventories_v1 The following keys were added: - schemas.LocalInventory.properties.base64EncodedName (Total Keys: 2) - schemas.RegionalInventory.properties.base64EncodedName (Total Keys: 2) #### merchantapi:inventories_v1beta The following keys were added: - schemas.LocalInventory.properties.base64EncodedName (Total Keys: 2) - schemas.RegionalInventory.properties.base64EncodedName (Total Keys: 2) #### merchantapi:products_v1 The following keys were added: - schemas.Product.properties.base64EncodedName (Total Keys: 2) - schemas.ProductInput.properties.base64EncodedName (Total Keys: 2) - schemas.ProductInput.properties.base64EncodedProduct (Total Keys: 2) #### merchantapi:products_v1beta The following keys were added: - schemas.Product.properties.base64EncodedName (Total Keys: 2) - schemas.ProductInput.properties.base64EncodedName (Total Keys: 2) - schemas.ProductInput.properties.base64EncodedProduct (Total Keys: 2) #### merchantapi:reports_v1 The following keys were added: - schemas.ProductPerformanceView.properties.storeType.type (Total Keys: 1) #### merchantapi:reports_v1beta The following keys were added: - schemas.ProductPerformanceView.properties.storeType.type (Total Keys: 1) --- ...nts_v1.accounts.developerRegistration.html | 2 +- ...hantapi_accounts_v1.accounts.services.html | 10 +++---- ...v1beta.accounts.developerRegistration.html | 2 +- ...api_accounts_v1beta.accounts.services.html | 10 +++---- ...v1.accounts.products.localInventories.html | 9 ++++--- ...accounts.products.regionalInventories.html | 15 ++++++----- ...ta.accounts.products.localInventories.html | 9 ++++--- ...accounts.products.regionalInventories.html | 15 ++++++----- ...pi_products_v1.accounts.productInputs.html | 20 +++++++++----- ...hantapi_products_v1.accounts.products.html | 2 ++ ...roducts_v1beta.accounts.productInputs.html | 20 +++++++++----- ...api_products_v1beta.accounts.products.html | 2 ++ ...rchantapi_reports_v1.accounts.reports.html | 1 + ...ntapi_reports_v1beta.accounts.reports.html | 1 + .../documents/merchantapi.accounts_v1.json | 8 +++--- .../merchantapi.accounts_v1beta.json | 8 +++--- .../documents/merchantapi.inventories_v1.json | 26 +++++++++++++------ .../merchantapi.inventories_v1beta.json | 26 +++++++++++++------ .../documents/merchantapi.products_v1.json | 23 +++++++++++++--- .../merchantapi.products_v1beta.json | 23 +++++++++++++--- .../documents/merchantapi.reports_v1.json | 16 +++++++++++- .../documents/merchantapi.reports_v1beta.json | 16 +++++++++++- 22 files changed, 190 insertions(+), 74 deletions(-) diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.developerRegistration.html b/docs/dyn/merchantapi_accounts_v1.accounts.developerRegistration.html index b3d0a3303e..c38407586a 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.developerRegistration.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.developerRegistration.html @@ -140,7 +140,7 @@

Method Details

Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an "API developer" and add the "developer_email" as a contact with "API notifications" email preference on.
 
 Args:
-  name: string, Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration` (required)
+  name: string, Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration` The {account} used must be the same account where user calling this API method is directly added to. (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.services.html b/docs/dyn/merchantapi_accounts_v1.accounts.services.html
index b24dadb16e..9acb4e2df2 100644
--- a/docs/dyn/merchantapi_accounts_v1.accounts.services.html
+++ b/docs/dyn/merchantapi_accounts_v1.accounts.services.html
@@ -126,7 +126,7 @@ 

Method Details

"comparisonShopping": { # `ComparisonShopping` payload. # Service type for comparison shopping. The provider is a CSS (Comparison Shopping Service) managing the account. See https://support.google.com/merchants/answer/12653197 }, "externalAccountId": "A String", # Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the `external_account_id` differentiates between them, ensuring accurate linking and integration between Google and the provider. - "handshake": { # The current status of establishing of the service. (for example, pending approval or approved). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). + "handshake": { # The current status of establishing of the service. (for example, pending approval, approved, established). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). "actor": "A String", # Output only. The most recent account to modify the account service's `approval_status`. "approvalState": "A String", # Output only. The approval state of this handshake. }, @@ -170,7 +170,7 @@

Method Details

"comparisonShopping": { # `ComparisonShopping` payload. # Service type for comparison shopping. The provider is a CSS (Comparison Shopping Service) managing the account. See https://support.google.com/merchants/answer/12653197 }, "externalAccountId": "A String", # Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the `external_account_id` differentiates between them, ensuring accurate linking and integration between Google and the provider. - "handshake": { # The current status of establishing of the service. (for example, pending approval or approved). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). + "handshake": { # The current status of establishing of the service. (for example, pending approval, approved, established). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). "actor": "A String", # Output only. The most recent account to modify the account service's `approval_status`. "approvalState": "A String", # Output only. The approval state of this handshake. }, @@ -213,7 +213,7 @@

Method Details

"comparisonShopping": { # `ComparisonShopping` payload. # Service type for comparison shopping. The provider is a CSS (Comparison Shopping Service) managing the account. See https://support.google.com/merchants/answer/12653197 }, "externalAccountId": "A String", # Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the `external_account_id` differentiates between them, ensuring accurate linking and integration between Google and the provider. - "handshake": { # The current status of establishing of the service. (for example, pending approval or approved). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). + "handshake": { # The current status of establishing of the service. (for example, pending approval, approved, established). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). "actor": "A String", # Output only. The most recent account to modify the account service's `approval_status`. "approvalState": "A String", # Output only. The approval state of this handshake. }, @@ -265,7 +265,7 @@

Method Details

"comparisonShopping": { # `ComparisonShopping` payload. # Service type for comparison shopping. The provider is a CSS (Comparison Shopping Service) managing the account. See https://support.google.com/merchants/answer/12653197 }, "externalAccountId": "A String", # Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the `external_account_id` differentiates between them, ensuring accurate linking and integration between Google and the provider. - "handshake": { # The current status of establishing of the service. (for example, pending approval or approved). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). + "handshake": { # The current status of establishing of the service. (for example, pending approval, approved, established). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). "actor": "A String", # Output only. The most recent account to modify the account service's `approval_status`. "approvalState": "A String", # Output only. The approval state of this handshake. }, @@ -299,7 +299,7 @@

Method Details

"comparisonShopping": { # `ComparisonShopping` payload. # Service type for comparison shopping. The provider is a CSS (Comparison Shopping Service) managing the account. See https://support.google.com/merchants/answer/12653197 }, "externalAccountId": "A String", # Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the `external_account_id` differentiates between them, ensuring accurate linking and integration between Google and the provider. - "handshake": { # The current status of establishing of the service. (for example, pending approval or approved). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). + "handshake": { # The current status of establishing of the service. (for example, pending approval, approved, established). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). "actor": "A String", # Output only. The most recent account to modify the account service's `approval_status`. "approvalState": "A String", # Output only. The approval state of this handshake. }, diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.developerRegistration.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.developerRegistration.html index 7b7b7f4ffc..0a8c13a9c6 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.developerRegistration.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.developerRegistration.html @@ -140,7 +140,7 @@

Method Details

Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an "API developer" and add the "developer_email" as a contact with "API notifications" email preference on.
 
 Args:
-  name: string, Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration` (required)
+  name: string, Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration` The {account} used must be the same account where user calling this API method is directly added to. (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.services.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.services.html
index 394d650186..88c7376132 100644
--- a/docs/dyn/merchantapi_accounts_v1beta.accounts.services.html
+++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.services.html
@@ -126,7 +126,7 @@ 

Method Details

"comparisonShopping": { # `ComparisonShopping` payload. # Service type for comparison shopping. The provider is a CSS (Comparison Shopping Service) managing the account. See https://support.google.com/merchants/answer/12653197 }, "externalAccountId": "A String", # Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the `external_account_id` differentiates between them, ensuring accurate linking and integration between Google and the provider. - "handshake": { # The current status of establishing of the service. (for example, pending approval or approved). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). + "handshake": { # The current status of establishing of the service. (for example, pending approval, approved, established). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). "actor": "A String", # Output only. The most recent account to modify the account service's `approval_status`. "approvalState": "A String", # Output only. The approval state of this handshake. }, @@ -170,7 +170,7 @@

Method Details

"comparisonShopping": { # `ComparisonShopping` payload. # Service type for comparison shopping. The provider is a CSS (Comparison Shopping Service) managing the account. See https://support.google.com/merchants/answer/12653197 }, "externalAccountId": "A String", # Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the `external_account_id` differentiates between them, ensuring accurate linking and integration between Google and the provider. - "handshake": { # The current status of establishing of the service. (for example, pending approval or approved). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). + "handshake": { # The current status of establishing of the service. (for example, pending approval, approved, established). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). "actor": "A String", # Output only. The most recent account to modify the account service's `approval_status`. "approvalState": "A String", # Output only. The approval state of this handshake. }, @@ -213,7 +213,7 @@

Method Details

"comparisonShopping": { # `ComparisonShopping` payload. # Service type for comparison shopping. The provider is a CSS (Comparison Shopping Service) managing the account. See https://support.google.com/merchants/answer/12653197 }, "externalAccountId": "A String", # Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the `external_account_id` differentiates between them, ensuring accurate linking and integration between Google and the provider. - "handshake": { # The current status of establishing of the service. (for example, pending approval or approved). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). + "handshake": { # The current status of establishing of the service. (for example, pending approval, approved, established). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). "actor": "A String", # Output only. The most recent account to modify the account service's `approval_status`. "approvalState": "A String", # Output only. The approval state of this handshake. }, @@ -265,7 +265,7 @@

Method Details

"comparisonShopping": { # `ComparisonShopping` payload. # Service type for comparison shopping. The provider is a CSS (Comparison Shopping Service) managing the account. See https://support.google.com/merchants/answer/12653197 }, "externalAccountId": "A String", # Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the `external_account_id` differentiates between them, ensuring accurate linking and integration between Google and the provider. - "handshake": { # The current status of establishing of the service. (for example, pending approval or approved). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). + "handshake": { # The current status of establishing of the service. (for example, pending approval, approved, established). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). "actor": "A String", # Output only. The most recent account to modify the account service's `approval_status`. "approvalState": "A String", # Output only. The approval state of this handshake. }, @@ -299,7 +299,7 @@

Method Details

"comparisonShopping": { # `ComparisonShopping` payload. # Service type for comparison shopping. The provider is a CSS (Comparison Shopping Service) managing the account. See https://support.google.com/merchants/answer/12653197 }, "externalAccountId": "A String", # Immutable. An optional, immutable identifier that Google uses to refer to this account when communicating with the provider. This should be the unique account ID within the provider's system (for example, your shop ID in Shopify). If you have multiple accounts with the same provider - for instance, different accounts for various regions — the `external_account_id` differentiates between them, ensuring accurate linking and integration between Google and the provider. - "handshake": { # The current status of establishing of the service. (for example, pending approval or approved). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). + "handshake": { # The current status of establishing of the service. (for example, pending approval, approved, established). # Output only. Information about the state of the service in terms of establishing it (e.g. is it pending approval or approved). "actor": "A String", # Output only. The most recent account to modify the account service's `approval_status`. "approvalState": "A String", # Output only. The approval state of this handshake. }, diff --git a/docs/dyn/merchantapi_inventories_v1.accounts.products.localInventories.html b/docs/dyn/merchantapi_inventories_v1.accounts.products.localInventories.html index 0e64deb65f..f5a922ad34 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-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)
+  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 unpadded 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,12 +118,13 @@ 

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-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)
+  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 unpadded 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:
 
 { # Local inventory information for the product. Represents in-store information for a specific product at the store specified by `storeCode`. For a list of all accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342).
   "account": "A String", # Output only. The account that owns the product. This field will be ignored if set by the client.
+  "base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123` for the decoded product ID `en~US~sku/123` and `store_code` "store123". Can be used directly as input to the API methods that require the local product identifier within the local inventory name to be encoded if it contains special characters, for example [`GetLocalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories/get).
   "localInventoryAttributes": { # Local inventory attributes. # Optional. A list of local inventory attributes.
     "availability": "A String", # [Availability](https://support.google.com/merchants/answer/3061342) of the product at this store.
     "instoreProductLocation": "A String", # Optional. Location of the product inside the store. Maximum length is 20 bytes.
@@ -177,6 +178,7 @@ 

Method Details

{ # Local inventory information for the product. Represents in-store information for a specific product at the store specified by `storeCode`. For a list of all accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342). "account": "A String", # Output only. The account that owns the product. This field will be ignored if set by the client. + "base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123` for the decoded product ID `en~US~sku/123` and `store_code` "store123". Can be used directly as input to the API methods that require the local product identifier within the local inventory name to be encoded if it contains special characters, for example [`GetLocalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories/get). "localInventoryAttributes": { # Local inventory attributes. # Optional. A list of local inventory attributes. "availability": "A String", # [Availability](https://support.google.com/merchants/answer/3061342) of the product at this store. "instoreProductLocation": "A String", # Optional. Location of the product inside the store. Maximum length is 20 bytes. @@ -226,7 +228,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-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)
+  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 unpadded 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.
@@ -241,6 +243,7 @@ 

Method Details

"localInventories": [ # The `LocalInventory` resources for the given product from the specified account. { # Local inventory information for the product. Represents in-store information for a specific product at the store specified by `storeCode`. For a list of all accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342). "account": "A String", # Output only. The account that owns the product. This field will be ignored if set by the client. + "base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123` for the decoded product ID `en~US~sku/123` and `store_code` "store123". Can be used directly as input to the API methods that require the local product identifier within the local inventory name to be encoded if it contains special characters, for example [`GetLocalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories/get). "localInventoryAttributes": { # Local inventory attributes. # Optional. A list of local inventory attributes. "availability": "A String", # [Availability](https://support.google.com/merchants/answer/3061342) of the product at this store. "instoreProductLocation": "A String", # Optional. Location of the product inside the store. Maximum length is 20 bytes. diff --git a/docs/dyn/merchantapi_inventories_v1.accounts.products.regionalInventories.html b/docs/dyn/merchantapi_inventories_v1.accounts.products.regionalInventories.html index 0951e5438f..106266f90b 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-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)
+  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 unpadded 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,14 @@ 

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-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)
+  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 unpadded 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-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.
+  "base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123` for the decoded product ID `en~US~sku/123` and `region` "region123". Can be used directly as input to the API methods that require the product identifier within the regional inventory name to be encoded if it contains special characters, for example [`GetRegionalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.regionalInventories/get).
+  "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 unpadded 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 +174,8 @@ 

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-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. + "base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123` for the decoded product ID `en~US~sku/123` and `region` "region123". Can be used directly as input to the API methods that require the product identifier within the regional inventory name to be encoded if it contains special characters, for example [`GetRegionalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.regionalInventories/get). + "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 unpadded 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 +220,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-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)
+  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 unpadded 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 +236,8 @@ 

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-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. + "base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123` for the decoded product ID `en~US~sku/123` and `region` "region123". Can be used directly as input to the API methods that require the product identifier within the regional inventory name to be encoded if it contains special characters, for example [`GetRegionalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.regionalInventories/get). + "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 unpadded 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 0b4927309f..b8ab0756c3 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-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)
+  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 unpadded 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,13 +118,14 @@ 

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-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)
+  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 unpadded 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:
 
 { # Local inventory information for the product. Represents in-store information for a specific product at the store specified by `storeCode`. For a list of all accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342).
   "account": "A String", # Output only. The account that owns the product. This field will be ignored if set by the client.
   "availability": "A String", # Availability of the product at this store. For accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342)
+  "base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123` for the decoded product ID `en~US~sku/123` and `store_code` "store123". Can be used directly as input to the API methods that require the local product identifier within the local inventory name to be encoded if it contains special characters, for example [`GetLocalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1beta/accounts.products.localInventories/get).
   "customAttributes": [ # A list of custom (merchant-provided) attributes. You can also use `CustomAttribute` to submit any attribute of the data specification in its generic form.
     { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
       "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
@@ -165,6 +166,7 @@ 

Method Details

{ # Local inventory information for the product. Represents in-store information for a specific product at the store specified by `storeCode`. For a list of all accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342). "account": "A String", # Output only. The account that owns the product. This field will be ignored if set by the client. "availability": "A String", # Availability of the product at this store. For accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342) + "base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123` for the decoded product ID `en~US~sku/123` and `store_code` "store123". Can be used directly as input to the API methods that require the local product identifier within the local inventory name to be encoded if it contains special characters, for example [`GetLocalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1beta/accounts.products.localInventories/get). "customAttributes": [ # A list of custom (merchant-provided) attributes. You can also use `CustomAttribute` to submit any attribute of the data specification in its generic form. { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. @@ -200,7 +202,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-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)
+  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 unpadded 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.
@@ -216,6 +218,7 @@ 

Method Details

{ # Local inventory information for the product. Represents in-store information for a specific product at the store specified by `storeCode`. For a list of all accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342). "account": "A String", # Output only. The account that owns the product. This field will be ignored if set by the client. "availability": "A String", # Availability of the product at this store. For accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342) + "base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123` for the decoded product ID `en~US~sku/123` and `store_code` "store123". Can be used directly as input to the API methods that require the local product identifier within the local inventory name to be encoded if it contains special characters, for example [`GetLocalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1beta/accounts.products.localInventories/get). "customAttributes": [ # A list of custom (merchant-provided) attributes. You can also use `CustomAttribute` to submit any attribute of the data specification in its generic form. { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. diff --git a/docs/dyn/merchantapi_inventories_v1beta.accounts.products.regionalInventories.html b/docs/dyn/merchantapi_inventories_v1beta.accounts.products.regionalInventories.html index 3c9f493fff..afea6e4be0 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-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)
+  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 unpadded 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,14 @@ 

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-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)
+  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 unpadded 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.
   "availability": "A String", # Availability of the product in this region. For accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/14644124).
+  "base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123` for the decoded product ID `en~US~sku/123` and `region` "region123". Can be used directly as input to the API methods that require the product identifier within the regional inventory name to be encoded if it contains special characters, for example [`GetRegionalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1beta/accounts.products.regionalInventories/get).
   "customAttributes": [ # A list of custom (merchant-provided) attributes. You can also use `CustomAttribute` to submit any attribute of the data specification in its generic form.
     { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
       "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
@@ -134,7 +135,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-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. + "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 unpadded 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). @@ -161,6 +162,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. "availability": "A String", # Availability of the product in this region. For accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/14644124). + "base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123` for the decoded product ID `en~US~sku/123` and `region` "region123". Can be used directly as input to the API methods that require the product identifier within the regional inventory name to be encoded if it contains special characters, for example [`GetRegionalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1beta/accounts.products.regionalInventories/get). "customAttributes": [ # A list of custom (merchant-provided) attributes. You can also use `CustomAttribute` to submit any attribute of the data specification in its generic form. { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. @@ -170,7 +172,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-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. + "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 unpadded 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 +194,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-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)
+  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 unpadded 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.
@@ -209,6 +211,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. "availability": "A String", # Availability of the product in this region. For accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/14644124). + "base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123` for the decoded product ID `en~US~sku/123` and `region` "region123". Can be used directly as input to the API methods that require the product identifier within the regional inventory name to be encoded if it contains special characters, for example [`GetRegionalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1beta/accounts.products.regionalInventories/get). "customAttributes": [ # A list of custom (merchant-provided) attributes. You can also use `CustomAttribute` to submit any attribute of the data specification in its generic form. { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. @@ -218,7 +221,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-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. + "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 unpadded 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_products_v1.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html index 87db4090a4..9903dcbacb 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-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)
+  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 unpadded 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
@@ -121,6 +121,8 @@ 

Method Details

The object takes the form of: { # This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. For more information, see [Manage products](/merchant/api/guides/products/overview). Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the [Products Data Specification](https://support.google.com/merchants/answer/188494) with [some exceptions](https://support.google.com/merchants/answer/7052112). The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style. + "base64EncodedName": "A String", # Output only. The **unpadded base64url encoded name** of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw` for the decoded product input name `accounts/123/productInputs/en~US~sku/123`. This field can be used directly as input to the API methods that require the product input name to be encoded if it contains special characters, for example [`GetProductInput`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.productInputs/get). + "base64EncodedProduct": "A String", # Output only. The **unpadded base64url encoded name** of the processed product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products/get). "contentLanguage": "A String", # Required. Immutable. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product. "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. @@ -133,7 +135,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-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. + "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 unpadded 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. @@ -472,6 +474,8 @@

Method Details

An object of the form: { # This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. For more information, see [Manage products](/merchant/api/guides/products/overview). Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the [Products Data Specification](https://support.google.com/merchants/answer/188494) with [some exceptions](https://support.google.com/merchants/answer/7052112). The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style. + "base64EncodedName": "A String", # Output only. The **unpadded base64url encoded name** of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw` for the decoded product input name `accounts/123/productInputs/en~US~sku/123`. This field can be used directly as input to the API methods that require the product input name to be encoded if it contains special characters, for example [`GetProductInput`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.productInputs/get). + "base64EncodedProduct": "A String", # Output only. The **unpadded base64url encoded name** of the processed product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products/get). "contentLanguage": "A String", # Required. Immutable. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product. "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. @@ -484,7 +488,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-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. + "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 unpadded 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,11 +823,13 @@

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-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)
+  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 unpadded 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:
 
 { # This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. For more information, see [Manage products](/merchant/api/guides/products/overview). Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the [Products Data Specification](https://support.google.com/merchants/answer/188494) with [some exceptions](https://support.google.com/merchants/answer/7052112). The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style.
+  "base64EncodedName": "A String", # Output only. The **unpadded base64url encoded name** of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw` for the decoded product input name `accounts/123/productInputs/en~US~sku/123`. This field can be used directly as input to the API methods that require the product input name to be encoded if it contains special characters, for example [`GetProductInput`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.productInputs/get).
+  "base64EncodedProduct": "A String", # Output only. The **unpadded base64url encoded name** of the processed product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products/get).
   "contentLanguage": "A String", # Required. Immutable. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.
   "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion.
     { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
@@ -836,7 +842,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-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. + "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 unpadded 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. @@ -1176,6 +1182,8 @@

Method Details

An object of the form: { # This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. For more information, see [Manage products](/merchant/api/guides/products/overview). Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the [Products Data Specification](https://support.google.com/merchants/answer/188494) with [some exceptions](https://support.google.com/merchants/answer/7052112). The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style. + "base64EncodedName": "A String", # Output only. The **unpadded base64url encoded name** of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw` for the decoded product input name `accounts/123/productInputs/en~US~sku/123`. This field can be used directly as input to the API methods that require the product input name to be encoded if it contains special characters, for example [`GetProductInput`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.productInputs/get). + "base64EncodedProduct": "A String", # Output only. The **unpadded base64url encoded name** of the processed product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products/get). "contentLanguage": "A String", # Required. Immutable. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product. "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. @@ -1188,7 +1196,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-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. + "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 unpadded 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_v1.accounts.products.html b/docs/dyn/merchantapi_products_v1.accounts.products.html index 7223831386..9507a81dbf 100644 --- a/docs/dyn/merchantapi_products_v1.accounts.products.html +++ b/docs/dyn/merchantapi_products_v1.accounts.products.html @@ -121,6 +121,7 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, }, + "base64EncodedName": "A String", # Output only. The **unpadded base64url encoded name** of the product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products/get). "contentLanguage": "A String", # Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product. "customAttributes": [ # Output only. A list of custom (merchant-provided) attributes. It can also be used to submit any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google. { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. @@ -531,6 +532,7 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, }, + "base64EncodedName": "A String", # Output only. The **unpadded base64url encoded name** of the product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products/get). "contentLanguage": "A String", # Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product. "customAttributes": [ # Output only. A list of custom (merchant-provided) attributes. It can also be used to submit any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google. { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. diff --git a/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html index 9e813172a2..223a8ad2b0 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-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)
+  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 unpadded 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
@@ -414,6 +414,8 @@ 

Method Details

}, "virtualModelLink": "A String", # URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information. }, + "base64EncodedName": "A String", # Output only. The **unpadded base64url encoded name** of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw` for the decoded product input name `accounts/123/productInputs/en~US~sku/123`. This field can be used directly as input to the API methods that require the product input name to be encoded if it contains special characters, for example [`GetProductInput`](https://developers.google.com/merchant/api/reference/rest/products_v1beta/accounts.productInputs/get). + "base64EncodedProduct": "A String", # Output only. The **unpadded base64url encoded name** of the processed product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1beta/accounts.products/get). "channel": "A String", # Immutable. The [channel](https://support.google.com/merchants/answer/7361332) of the product. "contentLanguage": "A String", # Required. Immutable. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product. "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. @@ -426,7 +428,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-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. + "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 unpadded 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. @@ -735,6 +737,8 @@

Method Details

}, "virtualModelLink": "A String", # URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information. }, + "base64EncodedName": "A String", # Output only. The **unpadded base64url encoded name** of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw` for the decoded product input name `accounts/123/productInputs/en~US~sku/123`. This field can be used directly as input to the API methods that require the product input name to be encoded if it contains special characters, for example [`GetProductInput`](https://developers.google.com/merchant/api/reference/rest/products_v1beta/accounts.productInputs/get). + "base64EncodedProduct": "A String", # Output only. The **unpadded base64url encoded name** of the processed product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1beta/accounts.products/get). "channel": "A String", # Immutable. The [channel](https://support.google.com/merchants/answer/7361332) of the product. "contentLanguage": "A String", # Required. Immutable. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product. "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. @@ -747,7 +751,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-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. + "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 unpadded 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 +763,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-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)
+  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 unpadded 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:
 
@@ -1057,6 +1061,8 @@ 

Method Details

}, "virtualModelLink": "A String", # URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information. }, + "base64EncodedName": "A String", # Output only. The **unpadded base64url encoded name** of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw` for the decoded product input name `accounts/123/productInputs/en~US~sku/123`. This field can be used directly as input to the API methods that require the product input name to be encoded if it contains special characters, for example [`GetProductInput`](https://developers.google.com/merchant/api/reference/rest/products_v1beta/accounts.productInputs/get). + "base64EncodedProduct": "A String", # Output only. The **unpadded base64url encoded name** of the processed product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1beta/accounts.products/get). "channel": "A String", # Immutable. The [channel](https://support.google.com/merchants/answer/7361332) of the product. "contentLanguage": "A String", # Required. Immutable. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product. "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. @@ -1069,7 +1075,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-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. + "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 unpadded 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. @@ -1379,6 +1385,8 @@

Method Details

}, "virtualModelLink": "A String", # URL of the 3D image of the item. See the [Help Center article](https://support.google.com/merchants/answer/13674896) for more information. }, + "base64EncodedName": "A String", # Output only. The **unpadded base64url encoded name** of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw` for the decoded product input name `accounts/123/productInputs/en~US~sku/123`. This field can be used directly as input to the API methods that require the product input name to be encoded if it contains special characters, for example [`GetProductInput`](https://developers.google.com/merchant/api/reference/rest/products_v1beta/accounts.productInputs/get). + "base64EncodedProduct": "A String", # Output only. The **unpadded base64url encoded name** of the processed product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1beta/accounts.products/get). "channel": "A String", # Immutable. The [channel](https://support.google.com/merchants/answer/7361332) of the product. "contentLanguage": "A String", # Required. Immutable. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product. "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. @@ -1391,7 +1399,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-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. + "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 unpadded 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/merchantapi_products_v1beta.accounts.products.html b/docs/dyn/merchantapi_products_v1beta.accounts.products.html index cec16aa0a6..a5df9a4740 100644 --- a/docs/dyn/merchantapi_products_v1beta.accounts.products.html +++ b/docs/dyn/merchantapi_products_v1beta.accounts.products.html @@ -414,6 +414,7 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, }, + "base64EncodedName": "A String", # Output only. The **unpadded base64url encoded name** of the product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1beta/accounts.products/get). "channel": "A String", # Output only. The [channel](https://support.google.com/merchants/answer/7361332) of the product. "contentLanguage": "A String", # Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product. "customAttributes": [ # Output only. A list of custom (merchant-provided) attributes. It can also be used to submit any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google. @@ -794,6 +795,7 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, }, + "base64EncodedName": "A String", # Output only. The **unpadded base64url encoded name** of the product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1beta/accounts.products/get). "channel": "A String", # Output only. The [channel](https://support.google.com/merchants/answer/7361332) of the product. "contentLanguage": "A String", # Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product. "customAttributes": [ # Output only. A list of custom (merchant-provided) attributes. It can also be used to submit any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google. diff --git a/docs/dyn/merchantapi_reports_v1.accounts.reports.html b/docs/dyn/merchantapi_reports_v1.accounts.reports.html index 806d169015..3fdffc69cb 100644 --- a/docs/dyn/merchantapi_reports_v1.accounts.reports.html +++ b/docs/dyn/merchantapi_reports_v1.accounts.reports.html @@ -306,6 +306,7 @@

Method Details

"productTypeL3": "A String", # [Product type (3rd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment. "productTypeL4": "A String", # [Product type (4th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment. "productTypeL5": "A String", # [Product type (5th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment. + "storeType": "A String", # Store type to which metrics apply. Can be `ONLINE_STORE` or `LOCAL_STORES`. Segment. For `LOCAL_STORES` store type, further segmentation by a specific store is not available. "title": "A String", # Title of the product. Segment. "week": { # 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 # First day of the week (Monday) of the metrics date in the merchant timezone. Segment. "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. diff --git a/docs/dyn/merchantapi_reports_v1beta.accounts.reports.html b/docs/dyn/merchantapi_reports_v1beta.accounts.reports.html index 5004426aae..ef66e441a7 100644 --- a/docs/dyn/merchantapi_reports_v1beta.accounts.reports.html +++ b/docs/dyn/merchantapi_reports_v1beta.accounts.reports.html @@ -306,6 +306,7 @@

Method Details

"productTypeL3": "A String", # [Product type (3rd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment. "productTypeL4": "A String", # [Product type (4th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment. "productTypeL5": "A String", # [Product type (5th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment. + "storeType": "A String", # Store type to which metrics apply. Can be `ONLINE_STORE` or `LOCAL_STORES`. Segment. For `LOCAL_STORES` store type, further segmentation by a specific store is not available. "title": "A String", # Title of the product. Segment. "week": { # 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 # First day of the week (Monday) of the metrics date in the merchant timezone. Segment. "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. diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json index 5b4a020a53..112fa89a8f 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json @@ -616,7 +616,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration`", +"description": "Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration` The {account} used must be the same account where user calling this API method is directly added to.", "location": "path", "pattern": "^accounts/[^/]+/developerRegistration$", "required": true, @@ -2438,7 +2438,7 @@ } } }, -"revision": "20260318", +"revision": "20260411", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -3616,7 +3616,7 @@ "type": "object" }, "Handshake": { -"description": "The current status of establishing of the service. (for example, pending approval or approved).", +"description": "The current status of establishing of the service. (for example, pending approval, approved, established).", "id": "Handshake", "properties": { "actor": { @@ -3639,12 +3639,14 @@ "enum": [ "APPROVAL_STATE_UNSPECIFIED", "PENDING", +"WAITING", "ESTABLISHED", "REJECTED" ], "enumDescriptions": [ "Unspecified approval status.", "The service was proposed and is waiting to be confirmed.", +"Indicates that the service proposal has been accepted and will be established after a fixed delay set by the service provider.", "Both parties have confirmed the service.", "The service proposal was rejected." ], diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json index 50514fb483..7ef40a9499 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json @@ -616,7 +616,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration`", +"description": "Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration` The {account} used must be the same account where user calling this API method is directly added to.", "location": "path", "pattern": "^accounts/[^/]+/developerRegistration$", "required": true, @@ -2388,7 +2388,7 @@ } } }, -"revision": "20260318", +"revision": "20260411", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -3493,7 +3493,7 @@ "type": "object" }, "Handshake": { -"description": "The current status of establishing of the service. (for example, pending approval or approved).", +"description": "The current status of establishing of the service. (for example, pending approval, approved, established).", "id": "Handshake", "properties": { "actor": { @@ -3516,12 +3516,14 @@ "enum": [ "APPROVAL_STATE_UNSPECIFIED", "PENDING", +"WAITING", "ESTABLISHED", "REJECTED" ], "enumDescriptions": [ "Unspecified approval status.", "The service was proposed and is waiting to be confirmed.", +"Indicates that the service proposal has been accepted and will be established after a fixed delay set by the service provider.", "Both parties have confirmed the service.", "The service proposal was rejected." ], diff --git a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json index 121a42e025..7ffe839d44 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-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.", +"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 unpadded 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-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.", +"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 unpadded 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-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.", +"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 unpadded 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-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.", +"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 unpadded 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-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.", +"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 unpadded 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-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.", +"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 unpadded 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": "20260327", +"revision": "20260408", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { @@ -408,6 +408,11 @@ "readOnly": true, "type": "string" }, +"base64EncodedName": { +"description": "Output only. The unpadded base64url encoded name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123` for the decoded product ID `en~US~sku/123` and `store_code` \"store123\". Can be used directly as input to the API methods that require the local product identifier within the local inventory name to be encoded if it contains special characters, for example [`GetLocalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories/get).", +"readOnly": true, +"type": "string" +}, "localInventoryAttributes": { "$ref": "LocalInventoryAttributes", "description": "Optional. A list of local inventory attributes." @@ -702,8 +707,13 @@ false "readOnly": true, "type": "string" }, +"base64EncodedName": { +"description": "Output only. The unpadded base64url encoded name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123` for the decoded product ID `en~US~sku/123` and `region` \"region123\". Can be used directly as input to the API methods that require the product identifier within the regional inventory name to be encoded if it contains special characters, for example [`GetRegionalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.regionalInventories/get).", +"readOnly": true, +"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-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.", +"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 unpadded 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 d327f3716c..e7a2e83fca 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-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.", +"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 unpadded 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-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.", +"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 unpadded 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-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.", +"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 unpadded 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-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.", +"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 unpadded 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-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.", +"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 unpadded 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-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.", +"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 unpadded 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": "20260327", +"revision": "20260411", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CustomAttribute": { @@ -398,6 +398,11 @@ "description": "Availability of the product at this store. For accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342)", "type": "string" }, +"base64EncodedName": { +"description": "Output only. The unpadded base64url encoded name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123` for the decoded product ID `en~US~sku/123` and `store_code` \"store123\". Can be used directly as input to the API methods that require the local product identifier within the local inventory name to be encoded if it contains special characters, for example [`GetLocalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1beta/accounts.products.localInventories/get).", +"readOnly": true, +"type": "string" +}, "customAttributes": { "deprecated": true, "description": "A list of custom (merchant-provided) attributes. You can also use `CustomAttribute` to submit any attribute of the data specification in its generic form.", @@ -630,6 +635,11 @@ false "description": "Availability of the product in this region. For accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/14644124).", "type": "string" }, +"base64EncodedName": { +"description": "Output only. The unpadded base64url encoded name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123` for the decoded product ID `en~US~sku/123` and `region` \"region123\". Can be used directly as input to the API methods that require the product identifier within the regional inventory name to be encoded if it contains special characters, for example [`GetRegionalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1beta/accounts.products.regionalInventories/get).", +"readOnly": true, +"type": "string" +}, "customAttributes": { "deprecated": true, "description": "A list of custom (merchant-provided) attributes. You can also use `CustomAttribute` to submit any attribute of the data specification in its generic form.", @@ -639,7 +649,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-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.", +"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 unpadded 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.products_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json index e6fac6f937..1b04f4e9ba 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-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.", +"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 unpadded 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-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.", +"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 unpadded 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": "20260327", +"revision": "20260408", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AutomatedDiscounts": { @@ -1036,6 +1036,11 @@ false "description": "Output only. The automated discounts information for the product.", "readOnly": true }, +"base64EncodedName": { +"description": "Output only. The **unpadded base64url encoded name** of the product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products/get).", +"readOnly": true, +"type": "string" +}, "contentLanguage": { "description": "Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.", "readOnly": true, @@ -2033,6 +2038,16 @@ false "description": "This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. For more information, see [Manage products](/merchant/api/guides/products/overview). Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the [Products Data Specification](https://support.google.com/merchants/answer/188494) with [some exceptions](https://support.google.com/merchants/answer/7052112). The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style.", "id": "ProductInput", "properties": { +"base64EncodedName": { +"description": "Output only. The **unpadded base64url encoded name** of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw` for the decoded product input name `accounts/123/productInputs/en~US~sku/123`. This field can be used directly as input to the API methods that require the product input name to be encoded if it contains special characters, for example [`GetProductInput`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.productInputs/get).", +"readOnly": true, +"type": "string" +}, +"base64EncodedProduct": { +"description": "Output only. The **unpadded base64url encoded name** of the processed product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products/get).", +"readOnly": true, +"type": "string" +}, "contentLanguage": { "description": "Required. Immutable. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.", "type": "string" @@ -2053,7 +2068,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-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.", +"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 unpadded 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 f47e7edef5..da6584df83 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-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.", +"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 unpadded 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-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.", +"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 unpadded 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": "20260327", +"revision": "20260408", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -1250,6 +1250,11 @@ false "description": "Output only. The automated discounts information for the product.", "readOnly": true }, +"base64EncodedName": { +"description": "Output only. The **unpadded base64url encoded name** of the product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1beta/accounts.products/get).", +"readOnly": true, +"type": "string" +}, "channel": { "description": "Output only. The [channel](https://support.google.com/merchants/answer/7361332) of the product.", "enum": [ @@ -1443,6 +1448,16 @@ false "$ref": "Attributes", "description": "Optional. A list of product attributes." }, +"base64EncodedName": { +"description": "Output only. The **unpadded base64url encoded name** of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw` for the decoded product input name `accounts/123/productInputs/en~US~sku/123`. This field can be used directly as input to the API methods that require the product input name to be encoded if it contains special characters, for example [`GetProductInput`](https://developers.google.com/merchant/api/reference/rest/products_v1beta/accounts.productInputs/get).", +"readOnly": true, +"type": "string" +}, +"base64EncodedProduct": { +"description": "Output only. The **unpadded base64url encoded name** of the processed product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1beta/accounts.products/get).", +"readOnly": true, +"type": "string" +}, "channel": { "description": "Immutable. The [channel](https://support.google.com/merchants/answer/7361332) of the product.", "enum": [ @@ -1473,7 +1488,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-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.", +"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 unpadded 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.reports_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json index 052ecc5044..2438a0f855 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json @@ -142,7 +142,7 @@ } } }, -"revision": "20260223", +"revision": "20260411", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "BestSellersBrandView": { @@ -1217,6 +1217,20 @@ false "description": "[Product type (5th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment.", "type": "string" }, +"storeType": { +"description": "Store type to which metrics apply. Can be `ONLINE_STORE` or `LOCAL_STORES`. Segment. For `LOCAL_STORES` store type, further segmentation by a specific store is not available.", +"enum": [ +"STORE_TYPE_ENUM_UNSPECIFIED", +"ONLINE_STORE", +"LOCAL_STORES" +], +"enumDescriptions": [ +"Not specified.", +"Online store.", +"Local (physical) stores." +], +"type": "string" +}, "title": { "description": "Title of the product. Segment.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json index a130ee3e4d..94a9f0c147 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json @@ -142,7 +142,7 @@ } } }, -"revision": "20260223", +"revision": "20260411", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "BestSellersBrandView": { @@ -1217,6 +1217,20 @@ false "description": "[Product type (5th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment.", "type": "string" }, +"storeType": { +"description": "Store type to which metrics apply. Can be `ONLINE_STORE` or `LOCAL_STORES`. Segment. For `LOCAL_STORES` store type, further segmentation by a specific store is not available.", +"enum": [ +"STORE_TYPE_ENUM_UNSPECIFIED", +"ONLINE_STORE", +"LOCAL_STORES" +], +"enumDescriptions": [ +"Not specified.", +"Online store.", +"Local (physical) stores." +], +"type": "string" +}, "title": { "description": "Title of the product. Segment.", "type": "string" From e6d1e48e33bde55b82a74116dca1c55c7e945bd3 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:41:01 +0000 Subject: [PATCH 24/32] feat(networkservices): update the api #### networkservices:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.agentGateways.methods.create (Total Keys: 14) - resources.projects.resources.locations.resources.agentGateways.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.agentGateways.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.agentGateways.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.agentGateways.methods.patch (Total Keys: 15) - schemas.AgentGateway (Total Keys: 48) - schemas.ListAgentGatewaysResponse (Total Keys: 7) --- ...eta1.projects.locations.agentGateways.html | 441 ++++++++++++++++++ ...rkservices_v1beta1.projects.locations.html | 5 + .../documents/networkservices.v1beta1.json | 376 ++++++++++++++- 3 files changed, 821 insertions(+), 1 deletion(-) create mode 100644 docs/dyn/networkservices_v1beta1.projects.locations.agentGateways.html diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.agentGateways.html b/docs/dyn/networkservices_v1beta1.projects.locations.agentGateways.html new file mode 100644 index 0000000000..db2163ade4 --- /dev/null +++ b/docs/dyn/networkservices_v1beta1.projects.locations.agentGateways.html @@ -0,0 +1,441 @@ + + + +

Network Services API . projects . locations . agentGateways

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new AgentGateway in a given project and location.

+

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

+

Deletes a single AgentGateway.

+

+ get(name, x__xgafv=None)

+

Gets details of a single AgentGateway.

+

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

+

Lists AgentGateways in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the parameters of a single AgentGateway.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, agentGatewayId=None, body=None, x__xgafv=None) +
Creates a new AgentGateway in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource of the AgentGateway. Must be in the format `projects/*/locations/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # AgentGateway represents the agent gateway resource.
+  "agentGatewayCard": { # AgentGatewayOutputCard contains informational output-only fields # Output only. Field for populated AgentGateway card.
+    "mtlsEndpoint": "A String", # Output only. mTLS Endpoint associated with this AgentGateway
+    "rootCertificates": [ # Output only. Root Certificates for Agents to validate this AgentGateway
+      "A String",
+    ],
+    "serviceExtensionsServiceAccount": "A String", # Output only. Service Account used by Service Extensions to operate.
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
+  "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
+  "googleManaged": { # Configuration for Google Managed deployment mode. Proxy is orchestrated and managed by GoogleCloud in a tenant project. # Optional. Proxy is orchestrated and managed by GoogleCloud in a tenant project.
+    "governedAccessPath": "A String", # Optional. Operating Mode of Agent Gateway.
+  },
+  "labels": { # Optional. Set of label tags associated with the AgentGateway resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Name of the AgentGateway resource. It matches pattern `projects/*/locations/*/agentGateways/`.
+  "networkConfig": { # NetworkConfig contains network configurations for the AgentGateway. # Optional. Network configuration for the AgentGateway.
+    "dnsPeeringConfig": { # DNS peering config for the user VPC network. # Optional. Optional DNS peering configuration for connectivity to your private VPC network.
+      "domains": [ # Required. Domain names for which DNS queries should be forwarded to the target network.
+        "A String",
+      ],
+      "targetNetwork": "A String", # Required. Target network in 'target project' to which DNS queries should be forwarded to. Must be in format of `projects/{project}/global/networks/{network}`.
+      "targetProject": "A String", # Required. Target project ID to which DNS queries should be forwarded to. This can be the same project that contains the AgentGateway or a different project.
+    },
+    "egress": { # Configuration for Egress # Optional. Optional PSC-Interface network attachment for connectivity to your private VPCs network.
+      "networkAttachment": "A String", # Optional. The URI of the Network Attachment resource.
+    },
+  },
+  "protocols": [ # Required. List of protocols supported by an Agent Gateway
+    "A String",
+  ],
+  "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/
+    "A String",
+  ],
+  "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies.
+    "resourceUri": "A String", # Optional. A supported Google Cloud networking proxy in the Project and Location
+  },
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+}
+
+  agentGatewayId: string, Required. Short name of the AgentGateway resource to be created.
+  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, x__xgafv=None) +
Deletes a single AgentGateway.
+
+Args:
+  name: string, Required. A name of the AgentGateway to delete. Must be in the format `projects/*/locations/*/agentGateways/*`. (required)
+  etag: string, Optional. The etag of the AgentGateway to delete.
+  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 AgentGateway.
+
+Args:
+  name: string, Required. A name of the AgentGateway to get. Must be in the format `projects/*/locations/*/agentGateways/*`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # AgentGateway represents the agent gateway resource.
+  "agentGatewayCard": { # AgentGatewayOutputCard contains informational output-only fields # Output only. Field for populated AgentGateway card.
+    "mtlsEndpoint": "A String", # Output only. mTLS Endpoint associated with this AgentGateway
+    "rootCertificates": [ # Output only. Root Certificates for Agents to validate this AgentGateway
+      "A String",
+    ],
+    "serviceExtensionsServiceAccount": "A String", # Output only. Service Account used by Service Extensions to operate.
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
+  "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
+  "googleManaged": { # Configuration for Google Managed deployment mode. Proxy is orchestrated and managed by GoogleCloud in a tenant project. # Optional. Proxy is orchestrated and managed by GoogleCloud in a tenant project.
+    "governedAccessPath": "A String", # Optional. Operating Mode of Agent Gateway.
+  },
+  "labels": { # Optional. Set of label tags associated with the AgentGateway resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Name of the AgentGateway resource. It matches pattern `projects/*/locations/*/agentGateways/`.
+  "networkConfig": { # NetworkConfig contains network configurations for the AgentGateway. # Optional. Network configuration for the AgentGateway.
+    "dnsPeeringConfig": { # DNS peering config for the user VPC network. # Optional. Optional DNS peering configuration for connectivity to your private VPC network.
+      "domains": [ # Required. Domain names for which DNS queries should be forwarded to the target network.
+        "A String",
+      ],
+      "targetNetwork": "A String", # Required. Target network in 'target project' to which DNS queries should be forwarded to. Must be in format of `projects/{project}/global/networks/{network}`.
+      "targetProject": "A String", # Required. Target project ID to which DNS queries should be forwarded to. This can be the same project that contains the AgentGateway or a different project.
+    },
+    "egress": { # Configuration for Egress # Optional. Optional PSC-Interface network attachment for connectivity to your private VPCs network.
+      "networkAttachment": "A String", # Optional. The URI of the Network Attachment resource.
+    },
+  },
+  "protocols": [ # Required. List of protocols supported by an Agent Gateway
+    "A String",
+  ],
+  "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/
+    "A String",
+  ],
+  "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies.
+    "resourceUri": "A String", # Optional. A supported Google Cloud networking proxy in the Project and Location
+  },
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists AgentGateways in a given project and location.
+
+Args:
+  parent: string, Required. The project and location from which the AgentGateways should be listed, specified in the format `projects/*/locations/*`. (required)
+  pageSize: integer, Optional. Maximum number of AgentGateways to return per call.
+  pageToken: string, Optional. The value returned by the last `ListAgentGatewaysResponse` Indicates that this is a continuation of a prior `ListAgentGateways` call, and that the system should return the next page of data.
+  returnPartialSuccess: boolean, Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response returned by the ListAgentGateways method.
+  "agentGateways": [ # List of AgentGateway resources.
+    { # AgentGateway represents the agent gateway resource.
+      "agentGatewayCard": { # AgentGatewayOutputCard contains informational output-only fields # Output only. Field for populated AgentGateway card.
+        "mtlsEndpoint": "A String", # Output only. mTLS Endpoint associated with this AgentGateway
+        "rootCertificates": [ # Output only. Root Certificates for Agents to validate this AgentGateway
+          "A String",
+        ],
+        "serviceExtensionsServiceAccount": "A String", # Output only. Service Account used by Service Extensions to operate.
+      },
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
+      "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
+      "googleManaged": { # Configuration for Google Managed deployment mode. Proxy is orchestrated and managed by GoogleCloud in a tenant project. # Optional. Proxy is orchestrated and managed by GoogleCloud in a tenant project.
+        "governedAccessPath": "A String", # Optional. Operating Mode of Agent Gateway.
+      },
+      "labels": { # Optional. Set of label tags associated with the AgentGateway resource.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. Name of the AgentGateway resource. It matches pattern `projects/*/locations/*/agentGateways/`.
+      "networkConfig": { # NetworkConfig contains network configurations for the AgentGateway. # Optional. Network configuration for the AgentGateway.
+        "dnsPeeringConfig": { # DNS peering config for the user VPC network. # Optional. Optional DNS peering configuration for connectivity to your private VPC network.
+          "domains": [ # Required. Domain names for which DNS queries should be forwarded to the target network.
+            "A String",
+          ],
+          "targetNetwork": "A String", # Required. Target network in 'target project' to which DNS queries should be forwarded to. Must be in format of `projects/{project}/global/networks/{network}`.
+          "targetProject": "A String", # Required. Target project ID to which DNS queries should be forwarded to. This can be the same project that contains the AgentGateway or a different project.
+        },
+        "egress": { # Configuration for Egress # Optional. Optional PSC-Interface network attachment for connectivity to your private VPCs network.
+          "networkAttachment": "A String", # Optional. The URI of the Network Attachment resource.
+        },
+      },
+      "protocols": [ # Required. List of protocols supported by an Agent Gateway
+        "A String",
+      ],
+      "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/
+        "A String",
+      ],
+      "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies.
+        "resourceUri": "A String", # Optional. A supported Google Cloud networking proxy in the Project and Location
+      },
+      "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+    },
+  ],
+  "nextPageToken": "A String", # If there might be 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`.
+  "unreachable": [ # Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.
+    "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, body=None, updateMask=None, x__xgafv=None) +
Updates the parameters of a single AgentGateway.
+
+Args:
+  name: string, Identifier. Name of the AgentGateway resource. It matches pattern `projects/*/locations/*/agentGateways/`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # AgentGateway represents the agent gateway resource.
+  "agentGatewayCard": { # AgentGatewayOutputCard contains informational output-only fields # Output only. Field for populated AgentGateway card.
+    "mtlsEndpoint": "A String", # Output only. mTLS Endpoint associated with this AgentGateway
+    "rootCertificates": [ # Output only. Root Certificates for Agents to validate this AgentGateway
+      "A String",
+    ],
+    "serviceExtensionsServiceAccount": "A String", # Output only. Service Account used by Service Extensions to operate.
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
+  "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
+  "googleManaged": { # Configuration for Google Managed deployment mode. Proxy is orchestrated and managed by GoogleCloud in a tenant project. # Optional. Proxy is orchestrated and managed by GoogleCloud in a tenant project.
+    "governedAccessPath": "A String", # Optional. Operating Mode of Agent Gateway.
+  },
+  "labels": { # Optional. Set of label tags associated with the AgentGateway resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. Name of the AgentGateway resource. It matches pattern `projects/*/locations/*/agentGateways/`.
+  "networkConfig": { # NetworkConfig contains network configurations for the AgentGateway. # Optional. Network configuration for the AgentGateway.
+    "dnsPeeringConfig": { # DNS peering config for the user VPC network. # Optional. Optional DNS peering configuration for connectivity to your private VPC network.
+      "domains": [ # Required. Domain names for which DNS queries should be forwarded to the target network.
+        "A String",
+      ],
+      "targetNetwork": "A String", # Required. Target network in 'target project' to which DNS queries should be forwarded to. Must be in format of `projects/{project}/global/networks/{network}`.
+      "targetProject": "A String", # Required. Target project ID to which DNS queries should be forwarded to. This can be the same project that contains the AgentGateway or a different project.
+    },
+    "egress": { # Configuration for Egress # Optional. Optional PSC-Interface network attachment for connectivity to your private VPCs network.
+      "networkAttachment": "A String", # Optional. The URI of the Network Attachment resource.
+    },
+  },
+  "protocols": [ # Required. List of protocols supported by an Agent Gateway
+    "A String",
+  ],
+  "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/
+    "A String",
+  ],
+  "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies.
+    "resourceUri": "A String", # Optional. A supported Google Cloud networking proxy in the Project and Location
+  },
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+}
+
+  updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the AgentGateway 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.
+  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/networkservices_v1beta1.projects.locations.html b/docs/dyn/networkservices_v1beta1.projects.locations.html index 6f6235dedb..d2ca62dc03 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.html @@ -74,6 +74,11 @@

Network Services API . projects . locations

Instance Methods

+

+ agentGateways() +

+

Returns the agentGateways Resource.

+

authzExtensions()

diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json index 885162675c..ed4fc8819c 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json @@ -183,6 +183,173 @@ } }, "resources": { +"agentGateways": { +"methods": { +"create": { +"description": "Creates a new AgentGateway in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentGateways", +"httpMethod": "POST", +"id": "networkservices.projects.locations.agentGateways.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"agentGatewayId": { +"description": "Required. Short name of the AgentGateway resource to be created.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource of the AgentGateway. Must be in the format `projects/*/locations/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/agentGateways", +"request": { +"$ref": "AgentGateway" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single AgentGateway.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentGateways/{agentGatewaysId}", +"httpMethod": "DELETE", +"id": "networkservices.projects.locations.agentGateways.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"etag": { +"description": "Optional. The etag of the AgentGateway to delete.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. A name of the AgentGateway to delete. Must be in the format `projects/*/locations/*/agentGateways/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agentGateways/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single AgentGateway.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentGateways/{agentGatewaysId}", +"httpMethod": "GET", +"id": "networkservices.projects.locations.agentGateways.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. A name of the AgentGateway to get. Must be in the format `projects/*/locations/*/agentGateways/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agentGateways/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "AgentGateway" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists AgentGateways in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentGateways", +"httpMethod": "GET", +"id": "networkservices.projects.locations.agentGateways.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Maximum number of AgentGateways to return per call.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The value returned by the last `ListAgentGatewaysResponse` Indicates that this is a continuation of a prior `ListAgentGateways` call, and that the system should return the next page of data.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project and location from which the AgentGateways should be listed, specified in the format `projects/*/locations/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+parent}/agentGateways", +"response": { +"$ref": "ListAgentGatewaysResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the parameters of a single AgentGateway.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentGateways/{agentGatewaysId}", +"httpMethod": "PATCH", +"id": "networkservices.projects.locations.agentGateways.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Name of the AgentGateway resource. It matches pattern `projects/*/locations/*/agentGateways/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agentGateways/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Field mask is used to specify the fields to be overwritten in the AgentGateway resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "AgentGateway" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "authzExtensions": { "methods": { "create": { @@ -3100,9 +3267,191 @@ } } }, -"revision": "20260330", +"revision": "20260407", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { +"AgentGateway": { +"description": "AgentGateway represents the agent gateway resource.", +"id": "AgentGateway", +"properties": { +"agentGatewayCard": { +"$ref": "AgentGatewayAgentGatewayOutputCard", +"description": "Output only. Field for populated AgentGateway card.", +"readOnly": true +}, +"createTime": { +"description": "Output only. The timestamp when the resource was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. A free-text description of the resource. Max length 1024 characters.", +"type": "string" +}, +"etag": { +"description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", +"type": "string" +}, +"googleManaged": { +"$ref": "AgentGatewayGoogleManaged", +"description": "Optional. Proxy is orchestrated and managed by GoogleCloud in a tenant project." +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Set of label tags associated with the AgentGateway resource.", +"type": "object" +}, +"name": { +"description": "Identifier. Name of the AgentGateway resource. It matches pattern `projects/*/locations/*/agentGateways/`.", +"type": "string" +}, +"networkConfig": { +"$ref": "AgentGatewayNetworkConfig", +"description": "Optional. Network configuration for the AgentGateway." +}, +"protocols": { +"description": "Required. List of protocols supported by an Agent Gateway", +"items": { +"enum": [ +"PROTOCOL_UNSPECIFIED", +"MCP" +], +"enumDescriptions": [ +"Unspecified protocol.", +"Message Control Plane protocol." +], +"type": "string" +}, +"type": "array" +}, +"registries": { +"description": "Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/", +"items": { +"type": "string" +}, +"type": "array" +}, +"selfManaged": { +"$ref": "AgentGatewaySelfManaged", +"description": "Optional. Attach to existing Application Load Balancers or Secure Web Proxies." +}, +"updateTime": { +"description": "Output only. The timestamp when the resource was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"AgentGatewayAgentGatewayOutputCard": { +"description": "AgentGatewayOutputCard contains informational output-only fields", +"id": "AgentGatewayAgentGatewayOutputCard", +"properties": { +"mtlsEndpoint": { +"description": "Output only. mTLS Endpoint associated with this AgentGateway", +"readOnly": true, +"type": "string" +}, +"rootCertificates": { +"description": "Output only. Root Certificates for Agents to validate this AgentGateway", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"serviceExtensionsServiceAccount": { +"description": "Output only. Service Account used by Service Extensions to operate.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"AgentGatewayGoogleManaged": { +"description": "Configuration for Google Managed deployment mode. Proxy is orchestrated and managed by GoogleCloud in a tenant project.", +"id": "AgentGatewayGoogleManaged", +"properties": { +"governedAccessPath": { +"description": "Optional. Operating Mode of Agent Gateway.", +"enum": [ +"GOVERNED_ACCESS_PATH_UNSPECIFIED", +"AGENT_TO_ANYWHERE", +"CLIENT_TO_AGENT" +], +"enumDescriptions": [ +"Governed access path is not specified.", +"Govern agent conections to destinations.", +"Protect connection to Agent or Tool." +], +"type": "string" +} +}, +"type": "object" +}, +"AgentGatewayNetworkConfig": { +"description": "NetworkConfig contains network configurations for the AgentGateway.", +"id": "AgentGatewayNetworkConfig", +"properties": { +"dnsPeeringConfig": { +"$ref": "AgentGatewayNetworkConfigDnsPeeringConfig", +"description": "Optional. Optional DNS peering configuration for connectivity to your private VPC network." +}, +"egress": { +"$ref": "AgentGatewayNetworkConfigEgress", +"description": "Optional. Optional PSC-Interface network attachment for connectivity to your private VPCs network." +} +}, +"type": "object" +}, +"AgentGatewayNetworkConfigDnsPeeringConfig": { +"description": "DNS peering config for the user VPC network.", +"id": "AgentGatewayNetworkConfigDnsPeeringConfig", +"properties": { +"domains": { +"description": "Required. Domain names for which DNS queries should be forwarded to the target network.", +"items": { +"type": "string" +}, +"type": "array" +}, +"targetNetwork": { +"description": "Required. Target network in 'target project' to which DNS queries should be forwarded to. Must be in format of `projects/{project}/global/networks/{network}`.", +"type": "string" +}, +"targetProject": { +"description": "Required. Target project ID to which DNS queries should be forwarded to. This can be the same project that contains the AgentGateway or a different project.", +"type": "string" +} +}, +"type": "object" +}, +"AgentGatewayNetworkConfigEgress": { +"description": "Configuration for Egress", +"id": "AgentGatewayNetworkConfigEgress", +"properties": { +"networkAttachment": { +"description": "Optional. The URI of the Network Attachment resource.", +"type": "string" +} +}, +"type": "object" +}, +"AgentGatewaySelfManaged": { +"description": "Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies.", +"id": "AgentGatewaySelfManaged", +"properties": { +"resourceUri": { +"description": "Optional. A supported Google Cloud networking proxy in the Project and Location", +"type": "string" +} +}, +"type": "object" +}, "AuthzExtension": { "description": "`AuthzExtension` is a resource that allows traffic forwarding to a callout backend service to make an authorization decision.", "id": "AuthzExtension", @@ -4740,6 +5089,31 @@ }, "type": "object" }, +"ListAgentGatewaysResponse": { +"description": "Response returned by the ListAgentGateways method.", +"id": "ListAgentGatewaysResponse", +"properties": { +"agentGateways": { +"description": "List of AgentGateway resources.", +"items": { +"$ref": "AgentGateway" +}, +"type": "array" +}, +"nextPageToken": { +"description": "If there might be 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" +}, +"unreachable": { +"description": "Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListAuthzExtensionsResponse": { "description": "Message for response to listing `AuthzExtension` resources.", "id": "ListAuthzExtensionsResponse", From 3ba3176c0a7b302f0f6967abb3daeadc13dcb282 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:41:01 +0000 Subject: [PATCH 25/32] feat(run): update the api #### run:v1 The following keys were added: - resources.namespaces.resources.instances.methods.replaceInstance (Total Keys: 12) #### run:v2 The following keys were added: - resources.projects.resources.locations.resources.instances.methods.patch (Total Keys: 19) --- .../dyn/run_v1.namespaces.configurations.html | 4 +- docs/dyn/run_v1.namespaces.executions.html | 6 +- docs/dyn/run_v1.namespaces.instances.html | 607 +++++++++++++++++- docs/dyn/run_v1.namespaces.jobs.html | 14 +- docs/dyn/run_v1.namespaces.revisions.html | 4 +- docs/dyn/run_v1.namespaces.services.html | 12 +- docs/dyn/run_v1.namespaces.tasks.html | 4 +- docs/dyn/run_v1.namespaces.workerpools.html | 12 +- ..._v1.projects.locations.configurations.html | 4 +- .../run_v1.projects.locations.revisions.html | 4 +- .../run_v1.projects.locations.services.html | 12 +- .../run_v2.projects.locations.instances.html | 312 ++++++++- ...v2.projects.locations.jobs.executions.html | 4 +- ...jects.locations.jobs.executions.tasks.html | 4 +- docs/dyn/run_v2.projects.locations.jobs.html | 8 +- .../run_v2.projects.locations.services.html | 8 +- ...projects.locations.services.revisions.html | 4 +- ...run_v2.projects.locations.workerPools.html | 8 +- ...jects.locations.workerPools.revisions.html | 4 +- .../discovery_cache/documents/run.v1.json | 33 +- .../discovery_cache/documents/run.v2.json | 49 +- 21 files changed, 1046 insertions(+), 71 deletions(-) diff --git a/docs/dyn/run_v1.namespaces.configurations.html b/docs/dyn/run_v1.namespaces.configurations.html index c0dbea4456..80506036af 100644 --- a/docs/dyn/run_v1.namespaces.configurations.html +++ b/docs/dyn/run_v1.namespaces.configurations.html @@ -349,7 +349,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -703,7 +703,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v1.namespaces.executions.html b/docs/dyn/run_v1.namespaces.executions.html index ca7ce10d5f..bec28f2031 100644 --- a/docs/dyn/run_v1.namespaces.executions.html +++ b/docs/dyn/run_v1.namespaces.executions.html @@ -325,7 +325,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -687,7 +687,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1010,7 +1010,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v1.namespaces.instances.html b/docs/dyn/run_v1.namespaces.instances.html index b66df2cdc6..65389cdd38 100644 --- a/docs/dyn/run_v1.namespaces.instances.html +++ b/docs/dyn/run_v1.namespaces.instances.html @@ -89,6 +89,9 @@

Instance Methods

list(parent, continue=None, fieldSelector=None, includeUninitialized=None, labelSelector=None, limit=None, resourceVersion=None, watch=None, x__xgafv=None)

List Instances. Results are sorted by creation time, descending.

+

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

+

Replace an Instance.

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

Start an Instance which has been stopped.

@@ -321,7 +324,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -616,7 +619,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -962,7 +965,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1274,7 +1277,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1362,6 +1365,598 @@

Method Details

}
+
+ replaceInstance(name, body=None, x__xgafv=None) +
Replace an Instance.
+
+Args:
+  name: string, Required. The name of the Instance being replaced. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Instance represents the configuration of a single Instance, which references a container image which is run to completion.
+  "apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.
+  "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase.
+  "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata.
+    "annotations": { # 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. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution.
+      "a_key": "A String",
+    },
+    "clusterName": "A String", # Not supported by Cloud Run
+    "creationTimestamp": "A String", # UTC timestamp representing the server time when this object was created.
+    "deletionGracePeriodSeconds": 42, # Not supported by Cloud Run
+    "deletionTimestamp": "A String", # The read-only soft deletion timestamp for this resource. In Cloud Run, users are not able to set this field. Instead, they must call the corresponding Delete API.
+    "finalizers": [ # Not supported by Cloud Run
+      "A String",
+    ],
+    "generateName": "A String", # Optional. A prefix for the resource name if not provided in the create request. Must be less than 31 characters to allow for a random suffix.
+    "generation": 42, # A system-provided sequence number representing a specific generation of the desired state.
+    "labels": { # Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.
+      "a_key": "A String",
+    },
+    "name": "A String", # Optional. The name of the resource. A name for creating top-level resources (Service, Job, WorkerPool). Must be unique within a Cloud Run project/region, and cannot be changed once created. If omitted, a default name will be generated.
+    "namespace": "A String", # Required. Defines the space within each name must be unique within a Cloud Run region. In Cloud Run, it must be project ID or number.
+    "ownerReferences": [ # Not supported by Cloud Run
+      { # This is not supported or used by Cloud Run.
+        "apiVersion": "A String", # This is not supported or used by Cloud Run.
+        "blockOwnerDeletion": True or False, # This is not supported or used by Cloud Run.
+        "controller": True or False, # This is not supported or used by Cloud Run.
+        "kind": "A String", # This is not supported or used by Cloud Run.
+        "name": "A String", # This is not supported or used by Cloud Run.
+        "uid": "A String", # This is not supported or used by Cloud Run.
+      },
+    ],
+    "resourceVersion": "A String", # Opaque, system-generated value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server or omit the value to disable conflict-detection.
+    "selfLink": "A String", # URL representing this object.
+    "uid": "A String", # Unique, system-generated identifier for this resource.
+  },
+  "spec": { # InstanceSpec describes how the Instance will look. # Optional. Specification of the desired behavior of a Instance.
+    "containers": [ # Optional. List of containers belonging to the Instance. We disallow a number of fields on this Container.
+      { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
+        "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
+          "A String",
+        ],
+        "command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
+          "A String",
+        ],
+        "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
+          { # EnvVar represents an environment variable present in a Container.
+            "name": "A String", # Required. Name of the environment variable.
+            "value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
+            "valueFrom": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. Only supports secret_key_ref. Cannot be used if value is not empty.
+              "configMapKeyRef": { # Not supported by Cloud Run. # Not supported by Cloud Run. Not supported in Cloud Run.
+                "key": "A String", # Required. Not supported by Cloud Run.
+                "localObjectReference": { # Not supported by Cloud Run. LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # Not supported by Cloud Run.
+                  "name": "A String", # Name of the referent.
+                },
+                "name": "A String", # Required. Not supported by Cloud Run.
+                "optional": True or False, # Not supported by Cloud Run.
+              },
+              "secretKeyRef": { # SecretKeySelector selects a key of a Secret. # Selects a key (version) of a secret in Secret Manager.
+                "key": "A String", # Required. A Cloud Secret Manager secret version. Must be 'latest' for the latest version, an integer for a specific version, or a version alias. The key of the secret to select from. Must be a valid secret key.
+                "localObjectReference": { # Not supported by Cloud Run. LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead.
+                  "name": "A String", # Name of the referent.
+                },
+                "name": "A String", # The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. If the secret is in another project, you must define an alias. An alias definition has the form: :projects//secrets/. If multiple alias definitions are needed, they must be separated by commas. The alias definitions must be set on the run.googleapis.com/secrets annotation. The name of the secret in the pod's namespace to select from.
+                "optional": True or False, # Specify whether the Secret or its key must be defined.
+              },
+            },
+          },
+        ],
+        "envFrom": [ # Not supported by Cloud Run.
+          { # Not supported by Cloud Run. EnvFromSource represents the source of a set of ConfigMaps
+            "configMapRef": { # Not supported by Cloud Run. ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. # The ConfigMap to select from
+              "localObjectReference": { # Not supported by Cloud Run. LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead.
+                "name": "A String", # Name of the referent.
+              },
+              "name": "A String", # The ConfigMap to select from.
+              "optional": True or False, # Specify whether the ConfigMap must be defined.
+            },
+            "prefix": "A String", # An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+            "secretRef": { # Not supported by Cloud Run. SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables. # The Secret to select from
+              "localObjectReference": { # Not supported by Cloud Run. LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead.
+                "name": "A String", # Name of the referent.
+              },
+              "name": "A String", # The Secret to select from.
+              "optional": True or False, # Specify whether the Secret must be defined
+            },
+          },
+        ],
+        "image": "A String", # Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed.
+        "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
+        "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Periodic probe of container liveness. Container will be restarted if the probe fails.
+          "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run.
+            "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+              "A String",
+            ],
+          },
+          "failureThreshold": 42, # Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+          "grpc": { # GRPCAction describes an action involving a GRPC port. # GRPCAction specifies an action involving a GRPC port.
+            "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
+            "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. If this is not specified, the default behavior is defined by gRPC.
+          },
+          "httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # HTTPGet specifies the http request to perform.
+            "host": "A String", # Not supported by Cloud Run.
+            "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
+              { # HTTPHeader describes a custom header to be used in HTTP probes
+                "name": "A String", # Required. The header field name
+                "value": "A String", # The header field value
+              },
+            ],
+            "path": "A String", # Path to access on the HTTP server.
+            "port": 42, # Port number to access on the container. Number must be in the range 1 to 65535.
+            "scheme": "A String", # Not supported by Cloud Run.
+          },
+          "initialDelaySeconds": 42, # Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
+          "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
+          "successThreshold": 42, # Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set.
+          "tcpSocket": { # TCPSocketAction describes an action based on opening a socket # TCPSocket specifies an action involving a TCP port.
+            "host": "A String", # Not supported by Cloud Run.
+            "port": 42, # Port number to access on the container. Number must be in the range 1 to 65535.
+          },
+          "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds; if period_seconds is not set, must be less or equal than 10.
+        },
+        "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
+        "ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
+          { # ContainerPort represents a network port in a single container.
+            "containerPort": 42, # Port number the container listens on. If present, this must be a valid port number, 0 < x < 65536. If not present, it will default to port 8080. For more information, see https://cloud.google.com/run/docs/container-contract#port
+            "name": "A String", # If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".
+            "protocol": "A String", # Protocol for port. Must be "TCP". Defaults to "TCP".
+          },
+        ],
+        "readinessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Readiness probe to be used for health checks.
+          "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run.
+            "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+              "A String",
+            ],
+          },
+          "failureThreshold": 42, # Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+          "grpc": { # GRPCAction describes an action involving a GRPC port. # GRPCAction specifies an action involving a GRPC port.
+            "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
+            "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. If this is not specified, the default behavior is defined by gRPC.
+          },
+          "httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # HTTPGet specifies the http request to perform.
+            "host": "A String", # Not supported by Cloud Run.
+            "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
+              { # HTTPHeader describes a custom header to be used in HTTP probes
+                "name": "A String", # Required. The header field name
+                "value": "A String", # The header field value
+              },
+            ],
+            "path": "A String", # Path to access on the HTTP server.
+            "port": 42, # Port number to access on the container. Number must be in the range 1 to 65535.
+            "scheme": "A String", # Not supported by Cloud Run.
+          },
+          "initialDelaySeconds": 42, # Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
+          "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
+          "successThreshold": 42, # Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set.
+          "tcpSocket": { # TCPSocketAction describes an action based on opening a socket # TCPSocket specifies an action involving a TCP port.
+            "host": "A String", # Not supported by Cloud Run.
+            "port": 42, # Port number to access on the container. Number must be in the range 1 to 65535.
+          },
+          "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds; if period_seconds is not set, must be less or equal than 10.
+        },
+        "resources": { # ResourceRequirements describes the compute resource requirements. # Compute Resources required by this container.
+          "limits": { # Limits describes the maximum amount of compute resources allowed. Only 'cpu', 'memory' and 'nvidia.com/gpu' keys are supported. * For supported 'cpu' values, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits. * The only supported 'nvidia.com/gpu' value is '1'.
+            "a_key": "A String",
+          },
+          "requests": { # Requests describes the minimum amount of compute resources required. Only `cpu` and `memory` are supported. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. * For supported 'cpu' values, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+            "a_key": "A String",
+          },
+        },
+        "securityContext": { # Not supported by Cloud Run. SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. # Not supported by Cloud Run.
+          "runAsUser": 42, # The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+        },
+        "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not receive traffic if the probe fails. If not provided, a default startup probe with TCP socket action is used.
+          "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run.
+            "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+              "A String",
+            ],
+          },
+          "failureThreshold": 42, # Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+          "grpc": { # GRPCAction describes an action involving a GRPC port. # GRPCAction specifies an action involving a GRPC port.
+            "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
+            "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. If this is not specified, the default behavior is defined by gRPC.
+          },
+          "httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # HTTPGet specifies the http request to perform.
+            "host": "A String", # Not supported by Cloud Run.
+            "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
+              { # HTTPHeader describes a custom header to be used in HTTP probes
+                "name": "A String", # Required. The header field name
+                "value": "A String", # The header field value
+              },
+            ],
+            "path": "A String", # Path to access on the HTTP server.
+            "port": 42, # Port number to access on the container. Number must be in the range 1 to 65535.
+            "scheme": "A String", # Not supported by Cloud Run.
+          },
+          "initialDelaySeconds": 42, # Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
+          "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
+          "successThreshold": 42, # Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set.
+          "tcpSocket": { # TCPSocketAction describes an action based on opening a socket # TCPSocket specifies an action involving a TCP port.
+            "host": "A String", # Not supported by Cloud Run.
+            "port": 42, # Port number to access on the container. Number must be in the range 1 to 65535.
+          },
+          "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds; if period_seconds is not set, must be less or equal than 10.
+        },
+        "terminationMessagePath": "A String", # Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log.
+        "terminationMessagePolicy": "A String", # Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
+        "volumeMounts": [ # Volume to mount into the container's filesystem. Only supports SecretVolumeSources. Pod volumes to mount into the container's filesystem.
+          { # VolumeMount describes a mounting of a Volume within a container.
+            "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'.
+            "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name.
+            "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run.
+            "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts.
+          },
+        ],
+        "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
+      },
+    ],
+    "nodeSelector": { # Optional. The Node Selector configuration. Map of selector key to a value which matches a node.
+      "a_key": "A String",
+    },
+    "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the Instance. The service account represents the identity of the running container, and determines what permissions the Instance has. If not provided, the Instance will use the project's default service account.
+    "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down.
+    "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the Instance.
+      { # Volume represents a named volume in a container.
+        "configMap": { # Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. # Not supported in Cloud Run.
+          "defaultMode": 42, # (Optional) Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
+          "items": [ # (Optional) If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional.
+            { # Maps a string key to a path within a volume.
+              "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value, or an integer or a secret alias for a specific version. The key to project.
+              "mode": 42, # (Optional) Mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
+              "path": "A String", # The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
+            },
+          ],
+          "name": "A String", # Name of the config.
+          "optional": True or False, # (Optional) Specify whether the Secret or its keys must be defined.
+        },
+        "csi": { # Storage volume source using the Container Storage Interface. # Volume specified by the Container Storage Interface driver
+          "driver": "A String", # name of the CSI driver for the requested storage system. Cloud Run supports the following drivers: * gcsfuse.run.googleapis.com : Mount a Cloud Storage Bucket as a volume.
+          "readOnly": True or False, # If true, mount the volume as read only. Defaults to false.
+          "volumeAttributes": { # stores driver specific attributes. For Google Cloud Storage volumes, the following attributes are supported: * bucketName: the name of the Cloud Storage bucket to mount. The Cloud Run Service identity must have access to this bucket. * mountOptions: comma-separated list of mount options to pass to the gcsfuse.
+            "a_key": "A String",
+          },
+        },
+        "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume.
+          "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+          "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir
+        },
+        "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved.
+        "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down.
+          "path": "A String", # Path that is exported by the NFS server.
+          "readOnly": True or False, # If true, mount the NFS volume as read only. Defaults to false.
+          "server": "A String", # Hostname or IP address of the NFS server.
+        },
+        "secret": { # A volume representing a secret stored in Google Secret Manager. The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secretName.
+          "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
+          "items": [ # A list of secret versions to mount in the volume. If no items are specified, the volume will expose a file with the same name as the secret name. The contents of the file will be the data in the latest version of the secret. If items are specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify both a key and a path.
+            { # Maps a string key to a path within a volume.
+              "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value, or an integer or a secret alias for a specific version. The key to project.
+              "mode": 42, # (Optional) Mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
+              "path": "A String", # The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
+            },
+          ],
+          "optional": True or False, # Not supported by Cloud Run.
+          "secretName": "A String", # The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. If the secret is in another project, you must define an alias. An alias definition has the form: :projects//secrets/. If multiple alias definitions are needed, they must be separated by commas. The alias definitions must be set on the run.googleapis.com/secrets annotation. Name of the secret in the container's namespace to use.
+        },
+      },
+    ],
+  },
+  "status": { # InstanceStatus represents the current state of a Instance. # Output only. Current status of a Instance.
+    "conditions": [ # Output only. Conditions communicate information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. Instance-specific conditions include: * `Ready`: `True` when the Instance is ready to be executed.
+      { # Conditions show the status of reconciliation progress on a given resource. Most resource use a top-level condition type "Ready" or "Completed" to show overall status with other conditions to checkpoint each stage of reconciliation. Note that if metadata.Generation does not equal status.ObservedGeneration, the conditions shown may not be relevant for the current spec.
+        "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.
+        "message": "A String", # Optional. Human readable message indicating details about the current status.
+        "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. These are intended to be stable, unique values which the client may use to trigger error handling logic, whereas messages which may be changed later by the server.
+        "severity": "A String", # Optional. How to interpret this condition. One of Error, Warning, or Info. Conditions of severity Info do not contribute to resource readiness.
+        "status": "A String", # Status of the condition, one of True, False, Unknown.
+        "type": "A String", # type is used to communicate the status of the reconciliation process. Types common to all resources include: * "Ready" or "Completed": True when the Resource is ready.
+      },
+    ],
+    "logUri": "A String", # Optional. URI where logs for this execution can be found in Cloud Console.
+    "observedGeneration": 42, # Output only. The 'generation' of the Instance that was last processed by the controller.
+    "urls": [ # Output only. All URLs serving traffic for this Instance.
+      "A String",
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Instance represents the configuration of a single Instance, which references a container image which is run to completion.
+  "apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.
+  "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase.
+  "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata.
+    "annotations": { # 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. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-enable-automatic-updates`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-function-target`: Service, Revision. * `run.googleapis.com/build-id`: Service, Revision. * `run.googleapis.com/build-image-uri`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-source-location`: Service, Revision. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/gpu-zonal-redundancy-disabled`: Revision. * `run.googleapis.com/health-check-disabled`: Revision. * `run.googleapis.com/ingress`: Service, Instance. * `run.googleapis.com/invoker-iam-disabled`: Service, Instance. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service. * `run.googleapis.com/maxScale`: Service. * `run.googleapis.com/manualInstanceCount`: Service. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. `run.googleapis.com/scalingMode`: Service. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution.
+      "a_key": "A String",
+    },
+    "clusterName": "A String", # Not supported by Cloud Run
+    "creationTimestamp": "A String", # UTC timestamp representing the server time when this object was created.
+    "deletionGracePeriodSeconds": 42, # Not supported by Cloud Run
+    "deletionTimestamp": "A String", # The read-only soft deletion timestamp for this resource. In Cloud Run, users are not able to set this field. Instead, they must call the corresponding Delete API.
+    "finalizers": [ # Not supported by Cloud Run
+      "A String",
+    ],
+    "generateName": "A String", # Optional. A prefix for the resource name if not provided in the create request. Must be less than 31 characters to allow for a random suffix.
+    "generation": 42, # A system-provided sequence number representing a specific generation of the desired state.
+    "labels": { # Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes.
+      "a_key": "A String",
+    },
+    "name": "A String", # Optional. The name of the resource. A name for creating top-level resources (Service, Job, WorkerPool). Must be unique within a Cloud Run project/region, and cannot be changed once created. If omitted, a default name will be generated.
+    "namespace": "A String", # Required. Defines the space within each name must be unique within a Cloud Run region. In Cloud Run, it must be project ID or number.
+    "ownerReferences": [ # Not supported by Cloud Run
+      { # This is not supported or used by Cloud Run.
+        "apiVersion": "A String", # This is not supported or used by Cloud Run.
+        "blockOwnerDeletion": True or False, # This is not supported or used by Cloud Run.
+        "controller": True or False, # This is not supported or used by Cloud Run.
+        "kind": "A String", # This is not supported or used by Cloud Run.
+        "name": "A String", # This is not supported or used by Cloud Run.
+        "uid": "A String", # This is not supported or used by Cloud Run.
+      },
+    ],
+    "resourceVersion": "A String", # Opaque, system-generated value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server or omit the value to disable conflict-detection.
+    "selfLink": "A String", # URL representing this object.
+    "uid": "A String", # Unique, system-generated identifier for this resource.
+  },
+  "spec": { # InstanceSpec describes how the Instance will look. # Optional. Specification of the desired behavior of a Instance.
+    "containers": [ # Optional. List of containers belonging to the Instance. We disallow a number of fields on this Container.
+      { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
+        "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run.
+          "A String",
+        ],
+        "command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
+          "A String",
+        ],
+        "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
+          { # EnvVar represents an environment variable present in a Container.
+            "name": "A String", # Required. Name of the environment variable.
+            "value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
+            "valueFrom": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. Only supports secret_key_ref. Cannot be used if value is not empty.
+              "configMapKeyRef": { # Not supported by Cloud Run. # Not supported by Cloud Run. Not supported in Cloud Run.
+                "key": "A String", # Required. Not supported by Cloud Run.
+                "localObjectReference": { # Not supported by Cloud Run. LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # Not supported by Cloud Run.
+                  "name": "A String", # Name of the referent.
+                },
+                "name": "A String", # Required. Not supported by Cloud Run.
+                "optional": True or False, # Not supported by Cloud Run.
+              },
+              "secretKeyRef": { # SecretKeySelector selects a key of a Secret. # Selects a key (version) of a secret in Secret Manager.
+                "key": "A String", # Required. A Cloud Secret Manager secret version. Must be 'latest' for the latest version, an integer for a specific version, or a version alias. The key of the secret to select from. Must be a valid secret key.
+                "localObjectReference": { # Not supported by Cloud Run. LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead.
+                  "name": "A String", # Name of the referent.
+                },
+                "name": "A String", # The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. If the secret is in another project, you must define an alias. An alias definition has the form: :projects//secrets/. If multiple alias definitions are needed, they must be separated by commas. The alias definitions must be set on the run.googleapis.com/secrets annotation. The name of the secret in the pod's namespace to select from.
+                "optional": True or False, # Specify whether the Secret or its key must be defined.
+              },
+            },
+          },
+        ],
+        "envFrom": [ # Not supported by Cloud Run.
+          { # Not supported by Cloud Run. EnvFromSource represents the source of a set of ConfigMaps
+            "configMapRef": { # Not supported by Cloud Run. ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. # The ConfigMap to select from
+              "localObjectReference": { # Not supported by Cloud Run. LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead.
+                "name": "A String", # Name of the referent.
+              },
+              "name": "A String", # The ConfigMap to select from.
+              "optional": True or False, # Specify whether the ConfigMap must be defined.
+            },
+            "prefix": "A String", # An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
+            "secretRef": { # Not supported by Cloud Run. SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables. # The Secret to select from
+              "localObjectReference": { # Not supported by Cloud Run. LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. # This field should not be used directly as it is meant to be inlined directly into the message. Use the "name" field instead.
+                "name": "A String", # Name of the referent.
+              },
+              "name": "A String", # The Secret to select from.
+              "optional": True or False, # Specify whether the Secret must be defined
+            },
+          },
+        ],
+        "image": "A String", # Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed.
+        "imagePullPolicy": "A String", # Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
+        "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Periodic probe of container liveness. Container will be restarted if the probe fails.
+          "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run.
+            "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+              "A String",
+            ],
+          },
+          "failureThreshold": 42, # Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+          "grpc": { # GRPCAction describes an action involving a GRPC port. # GRPCAction specifies an action involving a GRPC port.
+            "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
+            "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. If this is not specified, the default behavior is defined by gRPC.
+          },
+          "httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # HTTPGet specifies the http request to perform.
+            "host": "A String", # Not supported by Cloud Run.
+            "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
+              { # HTTPHeader describes a custom header to be used in HTTP probes
+                "name": "A String", # Required. The header field name
+                "value": "A String", # The header field value
+              },
+            ],
+            "path": "A String", # Path to access on the HTTP server.
+            "port": 42, # Port number to access on the container. Number must be in the range 1 to 65535.
+            "scheme": "A String", # Not supported by Cloud Run.
+          },
+          "initialDelaySeconds": 42, # Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
+          "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
+          "successThreshold": 42, # Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set.
+          "tcpSocket": { # TCPSocketAction describes an action based on opening a socket # TCPSocket specifies an action involving a TCP port.
+            "host": "A String", # Not supported by Cloud Run.
+            "port": 42, # Port number to access on the container. Number must be in the range 1 to 65535.
+          },
+          "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds; if period_seconds is not set, must be less or equal than 10.
+        },
+        "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
+        "ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
+          { # ContainerPort represents a network port in a single container.
+            "containerPort": 42, # Port number the container listens on. If present, this must be a valid port number, 0 < x < 65536. If not present, it will default to port 8080. For more information, see https://cloud.google.com/run/docs/container-contract#port
+            "name": "A String", # If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".
+            "protocol": "A String", # Protocol for port. Must be "TCP". Defaults to "TCP".
+          },
+        ],
+        "readinessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Readiness probe to be used for health checks.
+          "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run.
+            "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+              "A String",
+            ],
+          },
+          "failureThreshold": 42, # Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+          "grpc": { # GRPCAction describes an action involving a GRPC port. # GRPCAction specifies an action involving a GRPC port.
+            "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
+            "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. If this is not specified, the default behavior is defined by gRPC.
+          },
+          "httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # HTTPGet specifies the http request to perform.
+            "host": "A String", # Not supported by Cloud Run.
+            "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
+              { # HTTPHeader describes a custom header to be used in HTTP probes
+                "name": "A String", # Required. The header field name
+                "value": "A String", # The header field value
+              },
+            ],
+            "path": "A String", # Path to access on the HTTP server.
+            "port": 42, # Port number to access on the container. Number must be in the range 1 to 65535.
+            "scheme": "A String", # Not supported by Cloud Run.
+          },
+          "initialDelaySeconds": 42, # Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
+          "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
+          "successThreshold": 42, # Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set.
+          "tcpSocket": { # TCPSocketAction describes an action based on opening a socket # TCPSocket specifies an action involving a TCP port.
+            "host": "A String", # Not supported by Cloud Run.
+            "port": 42, # Port number to access on the container. Number must be in the range 1 to 65535.
+          },
+          "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds; if period_seconds is not set, must be less or equal than 10.
+        },
+        "resources": { # ResourceRequirements describes the compute resource requirements. # Compute Resources required by this container.
+          "limits": { # Limits describes the maximum amount of compute resources allowed. Only 'cpu', 'memory' and 'nvidia.com/gpu' keys are supported. * For supported 'cpu' values, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits. * The only supported 'nvidia.com/gpu' value is '1'.
+            "a_key": "A String",
+          },
+          "requests": { # Requests describes the minimum amount of compute resources required. Only `cpu` and `memory` are supported. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. * For supported 'cpu' values, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
+            "a_key": "A String",
+          },
+        },
+        "securityContext": { # Not supported by Cloud Run. SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. # Not supported by Cloud Run.
+          "runAsUser": 42, # The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
+        },
+        "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not receive traffic if the probe fails. If not provided, a default startup probe with TCP socket action is used.
+          "exec": { # Not supported by Cloud Run. ExecAction describes a "run in container" action. # Not supported by Cloud Run.
+            "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.
+              "A String",
+            ],
+          },
+          "failureThreshold": 42, # Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+          "grpc": { # GRPCAction describes an action involving a GRPC port. # GRPCAction specifies an action involving a GRPC port.
+            "port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535.
+            "service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest. If this is not specified, the default behavior is defined by gRPC.
+          },
+          "httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # HTTPGet specifies the http request to perform.
+            "host": "A String", # Not supported by Cloud Run.
+            "httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
+              { # HTTPHeader describes a custom header to be used in HTTP probes
+                "name": "A String", # Required. The header field name
+                "value": "A String", # The header field value
+              },
+            ],
+            "path": "A String", # Path to access on the HTTP server.
+            "port": 42, # Port number to access on the container. Number must be in the range 1 to 65535.
+            "scheme": "A String", # Not supported by Cloud Run.
+          },
+          "initialDelaySeconds": 42, # Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
+          "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
+          "successThreshold": 42, # Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set.
+          "tcpSocket": { # TCPSocketAction describes an action based on opening a socket # TCPSocket specifies an action involving a TCP port.
+            "host": "A String", # Not supported by Cloud Run.
+            "port": 42, # Port number to access on the container. Number must be in the range 1 to 65535.
+          },
+          "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds; if period_seconds is not set, must be less or equal than 10.
+        },
+        "terminationMessagePath": "A String", # Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log.
+        "terminationMessagePolicy": "A String", # Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
+        "volumeMounts": [ # Volume to mount into the container's filesystem. Only supports SecretVolumeSources. Pod volumes to mount into the container's filesystem.
+          { # VolumeMount describes a mounting of a Volume within a container.
+            "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'.
+            "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name.
+            "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run.
+            "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts.
+          },
+        ],
+        "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
+      },
+    ],
+    "nodeSelector": { # Optional. The Node Selector configuration. Map of selector key to a value which matches a node.
+      "a_key": "A String",
+    },
+    "serviceAccountName": "A String", # Optional. Email address of the IAM service account associated with the Instance. The service account represents the identity of the running container, and determines what permissions the Instance has. If not provided, the Instance will use the project's default service account.
+    "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down.
+    "volumes": [ # Optional. List of volumes that can be mounted by containers belonging to the Instance.
+      { # Volume represents a named volume in a container.
+        "configMap": { # Not supported by Cloud Run. Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. # Not supported in Cloud Run.
+          "defaultMode": 42, # (Optional) Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0644. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
+          "items": [ # (Optional) If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified that is not present in the Secret, the volume setup will error unless it is marked optional.
+            { # Maps a string key to a path within a volume.
+              "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value, or an integer or a secret alias for a specific version. The key to project.
+              "mode": 42, # (Optional) Mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
+              "path": "A String", # The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
+            },
+          ],
+          "name": "A String", # Name of the config.
+          "optional": True or False, # (Optional) Specify whether the Secret or its keys must be defined.
+        },
+        "csi": { # Storage volume source using the Container Storage Interface. # Volume specified by the Container Storage Interface driver
+          "driver": "A String", # name of the CSI driver for the requested storage system. Cloud Run supports the following drivers: * gcsfuse.run.googleapis.com : Mount a Cloud Storage Bucket as a volume.
+          "readOnly": True or False, # If true, mount the volume as read only. Defaults to false.
+          "volumeAttributes": { # stores driver specific attributes. For Google Cloud Storage volumes, the following attributes are supported: * bucketName: the name of the Cloud Storage bucket to mount. The Cloud Run Service identity must have access to this bucket. * mountOptions: comma-separated list of mount options to pass to the gcsfuse.
+            "a_key": "A String",
+          },
+        },
+        "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume.
+          "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
+          "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir
+        },
+        "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved.
+        "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down.
+          "path": "A String", # Path that is exported by the NFS server.
+          "readOnly": True or False, # If true, mount the NFS volume as read only. Defaults to false.
+          "server": "A String", # Hostname or IP address of the NFS server.
+        },
+        "secret": { # A volume representing a secret stored in Google Secret Manager. The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret_name. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secretName.
+          "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 01 and 0777 (octal). If 0 or not set, it will default to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
+          "items": [ # A list of secret versions to mount in the volume. If no items are specified, the volume will expose a file with the same name as the secret name. The contents of the file will be the data in the latest version of the secret. If items are specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify both a key and a path.
+            { # Maps a string key to a path within a volume.
+              "key": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value, or an integer or a secret alias for a specific version. The key to project.
+              "mode": 42, # (Optional) Mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
+              "path": "A String", # The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.
+            },
+          ],
+          "optional": True or False, # Not supported by Cloud Run.
+          "secretName": "A String", # The name of the secret in Cloud Secret Manager. By default, the secret is assumed to be in the same project. If the secret is in another project, you must define an alias. An alias definition has the form: :projects//secrets/. If multiple alias definitions are needed, they must be separated by commas. The alias definitions must be set on the run.googleapis.com/secrets annotation. Name of the secret in the container's namespace to use.
+        },
+      },
+    ],
+  },
+  "status": { # InstanceStatus represents the current state of a Instance. # Output only. Current status of a Instance.
+    "conditions": [ # Output only. Conditions communicate information about ongoing/complete reconciliation processes that bring the "spec" inline with the observed state of the world. Instance-specific conditions include: * `Ready`: `True` when the Instance is ready to be executed.
+      { # Conditions show the status of reconciliation progress on a given resource. Most resource use a top-level condition type "Ready" or "Completed" to show overall status with other conditions to checkpoint each stage of reconciliation. Note that if metadata.Generation does not equal status.ObservedGeneration, the conditions shown may not be relevant for the current spec.
+        "lastTransitionTime": "A String", # Optional. Last time the condition transitioned from one status to another.
+        "message": "A String", # Optional. Human readable message indicating details about the current status.
+        "reason": "A String", # Optional. One-word CamelCase reason for the condition's last transition. These are intended to be stable, unique values which the client may use to trigger error handling logic, whereas messages which may be changed later by the server.
+        "severity": "A String", # Optional. How to interpret this condition. One of Error, Warning, or Info. Conditions of severity Info do not contribute to resource readiness.
+        "status": "A String", # Status of the condition, one of True, False, Unknown.
+        "type": "A String", # type is used to communicate the status of the reconciliation process. Types common to all resources include: * "Ready" or "Completed": True when the Resource is ready.
+      },
+    ],
+    "logUri": "A String", # Optional. URI where logs for this execution can be found in Cloud Console.
+    "observedGeneration": 42, # Output only. The 'generation' of the Instance that was last processed by the controller.
+    "urls": [ # Output only. All URLs serving traffic for this Instance.
+      "A String",
+    ],
+  },
+}
+
+
start(name, body=None, x__xgafv=None)
Start an Instance which has been stopped.
@@ -1593,7 +2188,7 @@ 

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1901,7 +2496,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v1.namespaces.jobs.html b/docs/dyn/run_v1.namespaces.jobs.html index f72403cd63..24b07f8f35 100644 --- a/docs/dyn/run_v1.namespaces.jobs.html +++ b/docs/dyn/run_v1.namespaces.jobs.html @@ -361,7 +361,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -705,7 +705,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1100,7 +1100,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1461,7 +1461,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1818,7 +1818,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -2162,7 +2162,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -2520,7 +2520,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v1.namespaces.revisions.html b/docs/dyn/run_v1.namespaces.revisions.html index 346bc756df..aad8a4a30c 100644 --- a/docs/dyn/run_v1.namespaces.revisions.html +++ b/docs/dyn/run_v1.namespaces.revisions.html @@ -363,7 +363,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -683,7 +683,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v1.namespaces.services.html b/docs/dyn/run_v1.namespaces.services.html index 088561bbdd..184155296c 100644 --- a/docs/dyn/run_v1.namespaces.services.html +++ b/docs/dyn/run_v1.namespaces.services.html @@ -353,7 +353,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -715,7 +715,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1128,7 +1128,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1506,7 +1506,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1880,7 +1880,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -2242,7 +2242,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v1.namespaces.tasks.html b/docs/dyn/run_v1.namespaces.tasks.html index 25128f0516..d54a5dedd9 100644 --- a/docs/dyn/run_v1.namespaces.tasks.html +++ b/docs/dyn/run_v1.namespaces.tasks.html @@ -314,7 +314,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -641,7 +641,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v1.namespaces.workerpools.html b/docs/dyn/run_v1.namespaces.workerpools.html index 115adf7787..53ebfe909c 100644 --- a/docs/dyn/run_v1.namespaces.workerpools.html +++ b/docs/dyn/run_v1.namespaces.workerpools.html @@ -360,7 +360,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -712,7 +712,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1112,7 +1112,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1476,7 +1476,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1840,7 +1840,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -2192,7 +2192,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v1.projects.locations.configurations.html b/docs/dyn/run_v1.projects.locations.configurations.html index 744f49f1ce..9c2def82b8 100644 --- a/docs/dyn/run_v1.projects.locations.configurations.html +++ b/docs/dyn/run_v1.projects.locations.configurations.html @@ -349,7 +349,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -703,7 +703,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v1.projects.locations.revisions.html b/docs/dyn/run_v1.projects.locations.revisions.html index 8c76f5cfff..5a25770931 100644 --- a/docs/dyn/run_v1.projects.locations.revisions.html +++ b/docs/dyn/run_v1.projects.locations.revisions.html @@ -363,7 +363,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -683,7 +683,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v1.projects.locations.services.html b/docs/dyn/run_v1.projects.locations.services.html index 3e86d05cea..83206b8e22 100644 --- a/docs/dyn/run_v1.projects.locations.services.html +++ b/docs/dyn/run_v1.projects.locations.services.html @@ -362,7 +362,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -724,7 +724,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1137,7 +1137,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1563,7 +1563,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1937,7 +1937,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -2299,7 +2299,7 @@

Method Details

"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. "name": "A String", # Required. The name of the volume. There must be a corresponding Volume with the same name. "readOnly": True or False, # Sets the mount to be read-only or read-write. Not used by Cloud Run. - "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v2.projects.locations.instances.html b/docs/dyn/run_v2.projects.locations.instances.html index 7f549dd3d1..a8b664f474 100644 --- a/docs/dyn/run_v2.projects.locations.instances.html +++ b/docs/dyn/run_v2.projects.locations.instances.html @@ -92,6 +92,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

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

+

Updates an Instance.

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

Starts an Instance.

@@ -273,7 +276,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -617,7 +620,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -899,7 +902,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1019,6 +1022,309 @@

Method Details

+
+ patch(name, allowMissing=None, body=None, updateMask=None, validateOnly=None, x__xgafv=None) +
Updates an Instance.
+
+Args:
+  name: string, The fully qualified name of this Instance. In CreateInstanceRequest, this field is ignored, and instead composed from CreateInstanceRequest.parent and CreateInstanceRequest.instance_id. Format: projects/{project}/locations/{location}/instances/{instance_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A Cloud Run Instance represents a single group of containers running in a region.
+  "annotations": {
+    "a_key": "A String",
+  },
+  "binaryAuthorization": { # Settings for Binary Authorization feature. # Settings for the Binary Authorization feature.
+    "breakglassJustification": "A String", # Optional. If present, indicates to use Breakglass using this justification. If use_default is False, then it must be empty. For more information on breakglass, see https://cloud.google.com/binary-authorization/docs/using-breakglass
+    "policy": "A String", # Optional. The path to a binary authorization policy. Format: `projects/{project}/platforms/cloudRun/{policy-name}`
+    "useDefault": True or False, # Optional. If True, indicates to use the default project's binary authorization policy. If False, binary authorization will be disabled.
+  },
+  "client": "A String", # Arbitrary identifier for the API client.
+  "clientVersion": "A String", # Arbitrary version identifier for the API client.
+  "conditions": [ # Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Instance does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+    { # Defines a status condition for a resource.
+      "executionReason": "A String", # Output only. A reason for the execution condition.
+      "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
+      "message": "A String", # Human readable message indicating details about the current status.
+      "reason": "A String", # Output only. A common (service-level) reason for this condition.
+      "revisionReason": "A String", # Output only. A reason for the revision condition.
+      "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
+      "state": "A String", # State of the condition.
+      "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
+    },
+  ],
+  "containerStatuses": [ # Output only. Status information for each of the specified containers. The status includes the resolved digest for specified images.
+    { # ContainerStatus holds the information of container name and image digest value.
+      "imageDigest": "A String", # ImageDigest holds the resolved digest for the image specified and resolved during the creation of Revision. This field holds the digest value regardless of whether a tag or digest was originally specified in the Container object.
+      "name": "A String", # The name of the container, if specified.
+    },
+  ],
+  "containers": [ # Required. Holds the single container that defines the unit of execution for this Instance.
+    { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments can be supplied by the system to the container at runtime.
+      "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
+        "A String",
+      ],
+      "baseImageUri": "A String", # Base image for this container. Only supported for services. If set, it indicates that the service is enrolled into automatic base image update.
+      "buildInfo": { # Build information of the image. # Output only. The build info of the container image.
+        "functionTarget": "A String", # Output only. Entry point of the function when the image is a Cloud Run function.
+        "sourceLocation": "A String", # Output only. Source code location of the image.
+      },
+      "command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
+        "A String",
+      ],
+      "dependsOn": [ # Names of the containers that must start before this container.
+        "A String",
+      ],
+      "env": [ # List of environment variables to set in the container.
+        { # EnvVar represents an environment variable present in a Container.
+          "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters.
+          "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run.
+          "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value.
+            "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager.
+              "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project.
+              "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias.
+            },
+          },
+        },
+      ],
+      "image": "A String", # Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed.
+      "livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Periodic probe of container liveness. Container will be restarted if the probe fails.
+        "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+        "grpc": { # GRPCAction describes an action involving a GRPC port. # Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+          "port": 42, # Optional. Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+          "service": "A String", # Optional. Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md ). If this is not specified, the default behavior is defined by gRPC.
+        },
+        "httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+          "httpHeaders": [ # Optional. Custom headers to set in the request. HTTP allows repeated headers.
+            { # HTTPHeader describes a custom header to be used in HTTP probes
+              "name": "A String", # Required. The header field name
+              "value": "A String", # Optional. The header field value
+            },
+          ],
+          "path": "A String", # Optional. Path to access on the HTTP server. Defaults to '/'.
+          "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+        },
+        "initialDelaySeconds": 42, # Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
+        "periodSeconds": 42, # Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
+        "tcpSocket": { # TCPSocketAction describes an action based on opening a socket # Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+          "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+        },
+        "timeoutSeconds": 42, # Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
+      },
+      "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
+      "ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
+        { # ContainerPort represents a network port in a single container.
+          "containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
+          "name": "A String", # If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".
+        },
+      ],
+      "readinessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Readiness probe to be used for health checks.
+        "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+        "grpc": { # GRPCAction describes an action involving a GRPC port. # Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+          "port": 42, # Optional. Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+          "service": "A String", # Optional. Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md ). If this is not specified, the default behavior is defined by gRPC.
+        },
+        "httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+          "httpHeaders": [ # Optional. Custom headers to set in the request. HTTP allows repeated headers.
+            { # HTTPHeader describes a custom header to be used in HTTP probes
+              "name": "A String", # Required. The header field name
+              "value": "A String", # Optional. The header field value
+            },
+          ],
+          "path": "A String", # Optional. Path to access on the HTTP server. Defaults to '/'.
+          "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+        },
+        "initialDelaySeconds": 42, # Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
+        "periodSeconds": 42, # Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
+        "tcpSocket": { # TCPSocketAction describes an action based on opening a socket # Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+          "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+        },
+        "timeoutSeconds": 42, # Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
+      },
+      "resources": { # ResourceRequirements describes the compute resource requirements. # Compute Resource requirements by this container.
+        "cpuIdle": True or False, # Determines whether CPU is only allocated during requests (true by default). However, if ResourceRequirements is set, the caller must explicitly set this field to true to preserve the default behavior.
+        "limits": { # Only `memory`, `cpu` and `nvidia.com/gpu` keys in the map are supported. Notes: * The only supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU requires at least 2Gi of memory. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits * The only supported 'nvidia.com/gpu' value is '1'.
+          "a_key": "A String",
+        },
+        "startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency.
+      },
+      "sourceCode": { # Source type for the container. # Optional. Location of the source.
+        "cloudStorageSource": { # Cloud Storage source. # The source is a Cloud Storage bucket.
+          "bucket": "A String", # Required. The Cloud Storage bucket name.
+          "generation": "A String", # Optional. The Cloud Storage object generation.
+          "object": "A String", # Required. The Cloud Storage object name.
+        },
+        "inlinedSource": { # Inlined source. # Optional. Input only. Source code inlined in the request. Cloud Run will store the inlined_source to Cloud Storage and replace the field with cloud_storage_source.
+          "sources": [ # Required. Input only. The source code.
+            { # Source file.
+              "content": "A String", # Required. Input only. Represents the exact, literal, and complete source code of the file. Placeholders like `...` or comments such as `# [rest of code]` should NEVER be used as omission. Every character in this field will be built into the final container. Any omission will result in a broken application.
+              "filename": "A String", # Required. Input only. The file name for the source code. e.g., `"index.js"` or `"node_modules/dependency.js"`. The filename must be less than 255 characters and cannot contain `..`, `./`, `//`, or end with a `/`. Cloud Run will place the files in the container subdirectories, please use relative path to access the file.
+            },
+          ],
+        },
+      },
+      "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails.
+        "failureThreshold": 42, # Optional. Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
+        "grpc": { # GRPCAction describes an action involving a GRPC port. # Optional. GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+          "port": 42, # Optional. Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+          "service": "A String", # Optional. Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md ). If this is not specified, the default behavior is defined by gRPC.
+        },
+        "httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # Optional. HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+          "httpHeaders": [ # Optional. Custom headers to set in the request. HTTP allows repeated headers.
+            { # HTTPHeader describes a custom header to be used in HTTP probes
+              "name": "A String", # Required. The header field name
+              "value": "A String", # Optional. The header field value
+            },
+          ],
+          "path": "A String", # Optional. Path to access on the HTTP server. Defaults to '/'.
+          "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+        },
+        "initialDelaySeconds": 42, # Optional. Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
+        "periodSeconds": 42, # Optional. How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
+        "tcpSocket": { # TCPSocketAction describes an action based on opening a socket # Optional. TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
+          "port": 42, # Optional. Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
+        },
+        "timeoutSeconds": 42, # Optional. Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
+      },
+      "volumeMounts": [ # Volume to mount into the container's filesystem.
+        { # VolumeMount describes a mounting of a Volume within a container.
+          "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run
+          "name": "A String", # Required. This must match the Name of a Volume.
+          "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts.
+        },
+      ],
+      "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
+    },
+  ],
+  "createTime": "A String", # Output only. The creation time.
+  "creator": "A String", # Output only. Email address of the authenticated creator.
+  "deleteTime": "A String", # Output only. The deletion time.
+  "description": "A String", # User-provided description of the Instance. This field currently has a 512-character limit.
+  "encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
+  "encryptionKeyRevocationAction": "A String", # The action to take if the encryption key is revoked.
+  "encryptionKeyShutdownDuration": "A String", # If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.
+  "etag": "A String", # Optional. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
+  "expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permamently deleted.
+  "generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.
+  "gpuZonalRedundancyDisabled": True or False, # Optional. True if GPU zonal redundancy is disabled on this instance.
+  "iapEnabled": True or False, # Optional. IAP settings on the Instance.
+  "ingress": "A String", # Optional. Provides the ingress settings for this Instance. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active.
+  "invokerIamDisabled": True or False, # Optional. Disables IAM permission check for run.routes.invoke for callers of this Instance. For more information, visit https://cloud.google.com/run/docs/securing/managing-access#invoker_check.
+  "labels": {
+    "a_key": "A String",
+  },
+  "lastModifier": "A String", # Output only. Email address of the last authenticated modifier.
+  "launchStage": "A String", # The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output.
+  "logUri": "A String", # Output only. The Google Console URI to obtain logs for the Instance.
+  "name": "A String", # The fully qualified name of this Instance. In CreateInstanceRequest, this field is ignored, and instead composed from CreateInstanceRequest.parent and CreateInstanceRequest.instance_id. Format: projects/{project}/locations/{location}/instances/{instance_id}
+  "nodeSelector": { # Hardware constraints configuration. # Optional. The node selector for the instance.
+    "accelerator": "A String", # Required. GPU accelerator type to attach to an instance.
+  },
+  "observedGeneration": "A String", # Output only. The generation of this Instance currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`.
+  "reconciling": True or False, # Output only. Returns true if the Instance is currently being acted upon by the system to bring it into the desired state. When a new Instance is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Instance to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation` will have a transient value that might mismatch the intended state. Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Instance, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`.
+  "satisfiesPzs": True or False, # Output only. Reserved for future use.
+  "serviceAccount": "A String",
+  "terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Instance, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.
+    "executionReason": "A String", # Output only. A reason for the execution condition.
+    "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
+    "message": "A String", # Human readable message indicating details about the current status.
+    "reason": "A String", # Output only. A common (service-level) reason for this condition.
+    "revisionReason": "A String", # Output only. A reason for the revision condition.
+    "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
+    "state": "A String", # State of the condition.
+    "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
+  },
+  "timeout": "A String", # Optional. Duration the instance may be active before the system will shut it down.
+  "uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
+  "updateTime": "A String", # Output only. The last-modified time.
+  "urls": [ # Output only. All URLs serving traffic for this Instance.
+    "A String",
+  ],
+  "volumes": [ # A list of Volumes to make available to containers.
+    { # Volume represents a named volume in a container.
+      "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
+        "instances": [ # A list of Cloud SQL instance connection names. Cloud Run uses these to establish connections to the specified Cloud SQL instances. While the SQL instance name itself is unique within a project, the full connection name requires the location for proper routing. Format: `{project}:{location}:{instance}` Example: `my-project:us-central1:my-instance` You can find this value on the instance's **Overview** page in the Google Cloud console or by using the following `gcloud` command: ```sh gcloud sql instances describe INSTANCE_NAME \ --format='value(connectionName)' ``` Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
+          "A String",
+        ],
+      },
+      "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume.
+        "medium": "A String", # The medium on which the data is stored. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional
+        "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir
+      },
+      "gcs": { # Represents a volume backed by a Cloud Storage bucket using Cloud Storage FUSE. # Persistent storage backed by a Google Cloud Storage bucket.
+        "bucket": "A String", # Cloud Storage Bucket name.
+        "mountOptions": [ # A list of additional flags to pass to the gcsfuse CLI. Options should be specified without the leading "--".
+          "A String",
+        ],
+        "readOnly": True or False, # If true, the volume will be mounted as read only for all mounts.
+      },
+      "name": "A String", # Required. Volume's name.
+      "nfs": { # Represents an NFS mount. # For NFS Voumes, contains the path to the nfs Volume
+        "path": "A String", # Path that is exported by the NFS server.
+        "readOnly": True or False, # If true, the volume will be mounted as read only for all mounts.
+        "server": "A String", # Hostname or IP address of the NFS server
+      },
+      "secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume.
+        "defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set.
+        "items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path + VolumeMount.sub_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.
+          { # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path.
+            "mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
+            "path": "A String", # Required. The relative path of the secret in the container.
+            "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value, or an integer or a secret alias for a specific version.
+          },
+        ],
+        "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret} if the secret is in the same project. projects/{project}/secrets/{secret} if the secret is in a different project.
+      },
+    },
+  ],
+  "vpcAccess": { # VPC Access settings. For more information on sending traffic to a VPC network, visit https://cloud.google.com/run/docs/configuring/connecting-vpc. # Optional. VPC Access configuration to use for this Revision. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.
+    "connector": "A String", # VPC Access connector name. Format: `projects/{project}/locations/{location}/connectors/{connector}`, where `{project}` can be project id or number. For more information on sending traffic to a VPC network via a connector, visit https://cloud.google.com/run/docs/configuring/vpc-connectors.
+    "egress": "A String", # Optional. Traffic VPC egress settings. If not provided, it defaults to PRIVATE_RANGES_ONLY.
+    "networkInterfaces": [ # Optional. Direct VPC egress settings. Currently only single network interface is supported.
+      { # Direct VPC egress settings.
+        "network": "A String", # Optional. The VPC network that the Cloud Run resource will be able to send traffic to. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If network is not specified, it will be looked up from the subnetwork.
+        "subnetwork": "A String", # Optional. The VPC subnetwork that the Cloud Run resource will get IPs from. At least one of network or subnetwork must be specified. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.
+        "tags": [ # Optional. Network tags applied to this Cloud Run resource.
+          "A String",
+        ],
+      },
+    ],
+  },
+}
+
+  allowMissing: boolean, Optional. If set to true, and if the Instance does not exist, it will create a new one. The caller must have 'run.instances.create' permissions if this is set to true and the Instance does not exist.
+  updateMask: string, Optional. The list of fields to be updated.
+  validateOnly: boolean, Optional. Indicates that the request should be validated and default values populated, without persisting the request or updating any resources.
+  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.
+  },
+}
+
+
start(name, body=None, x__xgafv=None)
Starts an Instance.
diff --git a/docs/dyn/run_v2.projects.locations.jobs.executions.html b/docs/dyn/run_v2.projects.locations.jobs.executions.html
index c546d30bf3..50bb1cabd8 100644
--- a/docs/dyn/run_v2.projects.locations.jobs.executions.html
+++ b/docs/dyn/run_v2.projects.locations.jobs.executions.html
@@ -411,7 +411,7 @@ 

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -676,7 +676,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html index 0f495727e5..ad98df052e 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html +++ b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html @@ -254,7 +254,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -524,7 +524,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v2.projects.locations.jobs.html b/docs/dyn/run_v2.projects.locations.jobs.html index d542f3064e..e30343026f 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.html +++ b/docs/dyn/run_v2.projects.locations.jobs.html @@ -318,7 +318,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -672,7 +672,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1012,7 +1012,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1311,7 +1311,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v2.projects.locations.services.html b/docs/dyn/run_v2.projects.locations.services.html index ec0ea8b350..d143076e6b 100644 --- a/docs/dyn/run_v2.projects.locations.services.html +++ b/docs/dyn/run_v2.projects.locations.services.html @@ -334,7 +334,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -745,7 +745,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1143,7 +1143,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1501,7 +1501,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v2.projects.locations.services.revisions.html b/docs/dyn/run_v2.projects.locations.services.revisions.html index 5f1b237b97..039effcd29 100644 --- a/docs/dyn/run_v2.projects.locations.services.revisions.html +++ b/docs/dyn/run_v2.projects.locations.services.revisions.html @@ -334,7 +334,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -604,7 +604,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v2.projects.locations.workerPools.html b/docs/dyn/run_v2.projects.locations.workerPools.html index a62df79b11..a60637c983 100644 --- a/docs/dyn/run_v2.projects.locations.workerPools.html +++ b/docs/dyn/run_v2.projects.locations.workerPools.html @@ -322,7 +322,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -689,7 +689,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1043,7 +1043,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -1354,7 +1354,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/docs/dyn/run_v2.projects.locations.workerPools.revisions.html b/docs/dyn/run_v2.projects.locations.workerPools.revisions.html index a6800323bf..8a9290e41b 100644 --- a/docs/dyn/run_v2.projects.locations.workerPools.revisions.html +++ b/docs/dyn/run_v2.projects.locations.workerPools.revisions.html @@ -295,7 +295,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. @@ -565,7 +565,7 @@

Method Details

{ # VolumeMount describes a mounting of a Volume within a container. "mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run "name": "A String", # Required. This must match the Name of a Volume. - "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently ignored for Secret volumes. + "subPath": "A String", # Optional. Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). This field is currently rejected in Secret volume mounts. }, ], "workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index 2c40757036..ca4d0cb651 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -1221,6 +1221,35 @@ "https://www.googleapis.com/auth/run.readonly" ] }, +"replaceInstance": { +"description": "Replace an Instance.", +"flatPath": "apis/run.googleapis.com/v1/namespaces/{namespacesId}/instances/{instancesId}", +"httpMethod": "PUT", +"id": "run.namespaces.instances.replaceInstance", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Instance being replaced. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID", +"location": "path", +"pattern": "^namespaces/[^/]+/instances/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "apis/run.googleapis.com/v1/{+name}", +"request": { +"$ref": "Instance" +}, +"response": { +"$ref": "Instance" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/run" +] +}, "start": { "description": "Start an Instance which has been stopped.", "flatPath": "apis/run.googleapis.com/v1/namespaces/{namespacesId}/instances/{instancesId}:start", @@ -3583,7 +3612,7 @@ } } }, -"revision": "20260327", +"revision": "20260403", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -7886,7 +7915,7 @@ false "type": "boolean" }, "subPath": { -"description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root). This field is currently ignored for Secret volumes.", +"description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root). This field is currently rejected in Secret volume mounts.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index db1805840a..ab344f6f30 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -873,6 +873,51 @@ "https://www.googleapis.com/auth/run.readonly" ] }, +"patch": { +"description": "Updates an Instance.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", +"httpMethod": "PATCH", +"id": "run.projects.locations.instances.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"allowMissing": { +"description": "Optional. If set to true, and if the Instance does not exist, it will create a new one. The caller must have 'run.instances.create' permissions if this is set to true and the Instance does not exist.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "The fully qualified name of this Instance. In CreateInstanceRequest, this field is ignored, and instead composed from CreateInstanceRequest.parent and CreateInstanceRequest.instance_id. Format: projects/{project}/locations/{location}/instances/{instance_id}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "Optional. Indicates that the request should be validated and default values populated, without persisting the request or updating any resources.", +"location": "query", +"type": "boolean" +} +}, +"path": "v2/{+name}", +"request": { +"$ref": "GoogleCloudRunV2Instance" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/run" +] +}, "start": { "description": "Starts an Instance.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:start", @@ -2473,7 +2518,7 @@ } } }, -"revision": "20260327", +"revision": "20260403", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -5600,7 +5645,7 @@ "type": "string" }, "subPath": { -"description": "Optional. Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root). This field is currently ignored for Secret volumes.", +"description": "Optional. Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root). This field is currently rejected in Secret volume mounts.", "type": "string" } }, From f487642bc0d50480d9673a981d2f77acbb77beca Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:41:01 +0000 Subject: [PATCH 26/32] feat(saasservicemgmt): update the api #### saasservicemgmt:v1 The following keys were added: - schemas.FlagUpdate (Total Keys: 3) - schemas.Rollout.properties.flagRelease.type (Total Keys: 1) - schemas.UnitOperation.properties.flagUpdate.$ref (Total Keys: 1) #### saasservicemgmt:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.flagAttributes.methods.create (Total Keys: 18) - resources.projects.resources.locations.resources.flagAttributes.methods.delete (Total Keys: 15) - resources.projects.resources.locations.resources.flagAttributes.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.flagAttributes.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.flagAttributes.methods.patch (Total Keys: 19) - resources.projects.resources.locations.resources.flagReleases.methods.create (Total Keys: 18) - resources.projects.resources.locations.resources.flagReleases.methods.delete (Total Keys: 15) - resources.projects.resources.locations.resources.flagReleases.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.flagReleases.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.flagReleases.methods.patch (Total Keys: 19) - resources.projects.resources.locations.resources.flags.methods.create (Total Keys: 18) - resources.projects.resources.locations.resources.flags.methods.delete (Total Keys: 15) - resources.projects.resources.locations.resources.flags.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.flags.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.flags.methods.patch (Total Keys: 19) - schemas.Allocation (Total Keys: 11) - schemas.EvaluationRule (Total Keys: 5) - schemas.EvaluationSpec (Total Keys: 12) - schemas.Flag (Total Keys: 87) - schemas.ListFlagAttributesResponse (Total Keys: 7) - schemas.ListFlagReleasesResponse (Total Keys: 7) - schemas.ListFlagsResponse (Total Keys: 7) - schemas.Rollout.properties.flagRelease.type (Total Keys: 1) - schemas.Unit.properties.flagConfigName (Total Keys: 2) - schemas.UnitOperation.properties.flagUpdate.$ref (Total Keys: 1) - schemas.Variant (Total Keys: 9) --- docs/dyn/saasservicemgmt_v1.html | 2 +- docs/dyn/saasservicemgmt_v1.projects.html | 2 +- ...saasservicemgmt_v1.projects.locations.html | 2 +- ...cemgmt_v1.projects.locations.releases.html | 2 +- ...mt_v1.projects.locations.rolloutKinds.html | 2 +- ...cemgmt_v1.projects.locations.rollouts.html | 8 +- ...ervicemgmt_v1.projects.locations.saas.html | 2 +- ...icemgmt_v1.projects.locations.tenants.html | 26 +- ...emgmt_v1.projects.locations.unitKinds.html | 56 +- ..._v1.projects.locations.unitOperations.html | 20 +- ...rvicemgmt_v1.projects.locations.units.html | 20 +- docs/dyn/saasservicemgmt_v1beta1.html | 2 +- .../dyn/saasservicemgmt_v1beta1.projects.html | 2 +- ...ta1.projects.locations.flagAttributes.html | 325 +++ ...beta1.projects.locations.flagReleases.html | 457 ++++ ...eta1.projects.locations.flagRevisions.html | 919 +++++++ ...mgmt_v1beta1.projects.locations.flags.html | 625 +++++ ...ervicemgmt_v1beta1.projects.locations.html | 22 +- ...t_v1beta1.projects.locations.releases.html | 2 +- ...beta1.projects.locations.rolloutKinds.html | 2 +- ...t_v1beta1.projects.locations.rollouts.html | 8 +- ...emgmt_v1beta1.projects.locations.saas.html | 2 +- ...mt_v1beta1.projects.locations.tenants.html | 26 +- ..._v1beta1.projects.locations.unitKinds.html | 68 +- ...ta1.projects.locations.unitOperations.html | 20 +- ...mgmt_v1beta1.projects.locations.units.html | 26 +- .../documents/saasservicemgmt.v1.json | 77 +- .../documents/saasservicemgmt.v1beta1.json | 2350 ++++++++++++++--- 28 files changed, 4554 insertions(+), 521 deletions(-) create mode 100644 docs/dyn/saasservicemgmt_v1beta1.projects.locations.flagAttributes.html create mode 100644 docs/dyn/saasservicemgmt_v1beta1.projects.locations.flagReleases.html create mode 100644 docs/dyn/saasservicemgmt_v1beta1.projects.locations.flagRevisions.html create mode 100644 docs/dyn/saasservicemgmt_v1beta1.projects.locations.flags.html diff --git a/docs/dyn/saasservicemgmt_v1.html b/docs/dyn/saasservicemgmt_v1.html index 8435b4e33d..d4d9f81d63 100644 --- a/docs/dyn/saasservicemgmt_v1.html +++ b/docs/dyn/saasservicemgmt_v1.html @@ -72,7 +72,7 @@ -

SaaS Runtime API

+

App Lifecycle Manager API

Instance Methods

projects() diff --git a/docs/dyn/saasservicemgmt_v1.projects.html b/docs/dyn/saasservicemgmt_v1.projects.html index 4858bd03b2..548a9809bb 100644 --- a/docs/dyn/saasservicemgmt_v1.projects.html +++ b/docs/dyn/saasservicemgmt_v1.projects.html @@ -72,7 +72,7 @@ -

SaaS Runtime API . projects

+

App Lifecycle Manager API . projects

Instance Methods

locations() diff --git a/docs/dyn/saasservicemgmt_v1.projects.locations.html b/docs/dyn/saasservicemgmt_v1.projects.locations.html index b8d752e5b6..a82c719b6f 100644 --- a/docs/dyn/saasservicemgmt_v1.projects.locations.html +++ b/docs/dyn/saasservicemgmt_v1.projects.locations.html @@ -72,7 +72,7 @@ -

SaaS Runtime API . projects . locations

+

App Lifecycle Manager API . projects . locations

Instance Methods

releases() diff --git a/docs/dyn/saasservicemgmt_v1.projects.locations.releases.html b/docs/dyn/saasservicemgmt_v1.projects.locations.releases.html index 7ec4444579..023bf79cbe 100644 --- a/docs/dyn/saasservicemgmt_v1.projects.locations.releases.html +++ b/docs/dyn/saasservicemgmt_v1.projects.locations.releases.html @@ -72,7 +72,7 @@ -

SaaS Runtime API . projects . locations . releases

+

App Lifecycle Manager API . projects . locations . releases

Instance Methods

close()

diff --git a/docs/dyn/saasservicemgmt_v1.projects.locations.rolloutKinds.html b/docs/dyn/saasservicemgmt_v1.projects.locations.rolloutKinds.html index eb63a66815..ae9879985f 100644 --- a/docs/dyn/saasservicemgmt_v1.projects.locations.rolloutKinds.html +++ b/docs/dyn/saasservicemgmt_v1.projects.locations.rolloutKinds.html @@ -72,7 +72,7 @@ -

SaaS Runtime API . projects . locations . rolloutKinds

+

App Lifecycle Manager API . projects . locations . rolloutKinds

Instance Methods

close()

diff --git a/docs/dyn/saasservicemgmt_v1.projects.locations.rollouts.html b/docs/dyn/saasservicemgmt_v1.projects.locations.rollouts.html index 94ac4c1db4..1dc152384c 100644 --- a/docs/dyn/saasservicemgmt_v1.projects.locations.rollouts.html +++ b/docs/dyn/saasservicemgmt_v1.projects.locations.rollouts.html @@ -72,7 +72,7 @@ -

SaaS Runtime API . projects . locations . rollouts

+

App Lifecycle Manager API . projects . locations . rollouts

Instance Methods

close()

@@ -125,6 +125,7 @@

Method Details

"effectiveUnitFilter": "A String", # Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind.unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here. "endTime": "A String", # Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final. "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. + "flagRelease": "A String", # Optional. Immutable. Name of the FlagRelease to be rolled out to the target Units. Release and FlagRelease are mutually exclusive. Note: `release` comment needs to be adjusted to mention that "Release and FlagRelease are mutually exclusive" when visibility restriction will be lifted. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, @@ -178,6 +179,7 @@

Method Details

"effectiveUnitFilter": "A String", # Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind.unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here. "endTime": "A String", # Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final. "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. + "flagRelease": "A String", # Optional. Immutable. Name of the FlagRelease to be rolled out to the target Units. Release and FlagRelease are mutually exclusive. Note: `release` comment needs to be adjusted to mention that "Release and FlagRelease are mutually exclusive" when visibility restriction will be lifted. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, @@ -256,6 +258,7 @@

Method Details

"effectiveUnitFilter": "A String", # Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind.unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here. "endTime": "A String", # Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final. "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. + "flagRelease": "A String", # Optional. Immutable. Name of the FlagRelease to be rolled out to the target Units. Release and FlagRelease are mutually exclusive. Note: `release` comment needs to be adjusted to mention that "Release and FlagRelease are mutually exclusive" when visibility restriction will be lifted. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, @@ -320,6 +323,7 @@

Method Details

"effectiveUnitFilter": "A String", # Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind.unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here. "endTime": "A String", # Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final. "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. + "flagRelease": "A String", # Optional. Immutable. Name of the FlagRelease to be rolled out to the target Units. Release and FlagRelease are mutually exclusive. Note: `release` comment needs to be adjusted to mention that "Release and FlagRelease are mutually exclusive" when visibility restriction will be lifted. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, @@ -391,6 +395,7 @@

Method Details

"effectiveUnitFilter": "A String", # Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind.unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here. "endTime": "A String", # Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final. "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. + "flagRelease": "A String", # Optional. Immutable. Name of the FlagRelease to be rolled out to the target Units. Release and FlagRelease are mutually exclusive. Note: `release` comment needs to be adjusted to mention that "Release and FlagRelease are mutually exclusive" when visibility restriction will be lifted. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, @@ -444,6 +449,7 @@

Method Details

"effectiveUnitFilter": "A String", # Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind.unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here. "endTime": "A String", # Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final. "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. + "flagRelease": "A String", # Optional. Immutable. Name of the FlagRelease to be rolled out to the target Units. Release and FlagRelease are mutually exclusive. Note: `release` comment needs to be adjusted to mention that "Release and FlagRelease are mutually exclusive" when visibility restriction will be lifted. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, diff --git a/docs/dyn/saasservicemgmt_v1.projects.locations.saas.html b/docs/dyn/saasservicemgmt_v1.projects.locations.saas.html index f04c730a93..2b1571a614 100644 --- a/docs/dyn/saasservicemgmt_v1.projects.locations.saas.html +++ b/docs/dyn/saasservicemgmt_v1.projects.locations.saas.html @@ -72,7 +72,7 @@ -

SaaS Runtime API . projects . locations . saas

+

App Lifecycle Manager API . projects . locations . saas

Instance Methods

close()

diff --git a/docs/dyn/saasservicemgmt_v1.projects.locations.tenants.html b/docs/dyn/saasservicemgmt_v1.projects.locations.tenants.html index 282b788fa4..6778aee2be 100644 --- a/docs/dyn/saasservicemgmt_v1.projects.locations.tenants.html +++ b/docs/dyn/saasservicemgmt_v1.projects.locations.tenants.html @@ -72,7 +72,7 @@ -

SaaS Runtime API . projects . locations . tenants

+

App Lifecycle Manager API . projects . locations . tenants

Instance Methods

close()

@@ -114,14 +114,14 @@

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", }, - "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by SaaS Runtime for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). + "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by App Lifecycle Manager for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). "createTime": "A String", # Output only. The timestamp when the resource was created. "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", }, "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/tenants/{tenant}" - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. "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. } @@ -141,14 +141,14 @@

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", }, - "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by SaaS Runtime for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). + "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by App Lifecycle Manager for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). "createTime": "A String", # Output only. The timestamp when the resource was created. "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", }, "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/tenants/{tenant}" - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. "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. }
@@ -193,14 +193,14 @@

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", }, - "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by SaaS Runtime for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). + "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by App Lifecycle Manager for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). "createTime": "A String", # Output only. The timestamp when the resource was created. "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", }, "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/tenants/{tenant}" - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. "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. }
@@ -231,14 +231,14 @@

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", }, - "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by SaaS Runtime for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). + "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by App Lifecycle Manager for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). "createTime": "A String", # Output only. The timestamp when the resource was created. "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", }, "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/tenants/{tenant}" - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. "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. }, @@ -276,14 +276,14 @@

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", }, - "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by SaaS Runtime for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). + "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by App Lifecycle Manager for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). "createTime": "A String", # Output only. The timestamp when the resource was created. "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", }, "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/tenants/{tenant}" - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. "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. } @@ -303,14 +303,14 @@

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", }, - "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by SaaS Runtime for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). + "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by App Lifecycle Manager for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). "createTime": "A String", # Output only. The timestamp when the resource was created. "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", }, "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/tenants/{tenant}" - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. "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_v1.projects.locations.unitKinds.html b/docs/dyn/saasservicemgmt_v1.projects.locations.unitKinds.html index a410d443d1..82ca328ebe 100644 --- a/docs/dyn/saasservicemgmt_v1.projects.locations.unitKinds.html +++ b/docs/dyn/saasservicemgmt_v1.projects.locations.unitKinds.html @@ -72,7 +72,7 @@ -

SaaS Runtime API . projects . locations . unitKinds

+

App Lifecycle Manager API . projects . locations . unitKinds

Instance Methods

close()

@@ -115,6 +115,9 @@

Method Details

"a_key": "A String", }, "createTime": "A String", # Output only. The timestamp when the resource was created. + "defaultFlagRevisions": [ # Optional. Default revisions of flags for this UnitKind. Newly created units will use the flag default_flag_revisions present at the time of creation. + "A String", + ], "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. { # Dependency represent a single dependency with another unit kind by alias. @@ -131,7 +134,7 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable @@ -149,13 +152,13 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable }, ], - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. Immutable once set. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. Immutable once set. "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. } @@ -176,6 +179,9 @@

Method Details

"a_key": "A String", }, "createTime": "A String", # Output only. The timestamp when the resource was created. + "defaultFlagRevisions": [ # Optional. Default revisions of flags for this UnitKind. Newly created units will use the flag default_flag_revisions present at the time of creation. + "A String", + ], "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. { # Dependency represent a single dependency with another unit kind by alias. @@ -192,7 +198,7 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable @@ -210,13 +216,13 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable }, ], - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. Immutable once set. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. Immutable once set. "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. }
@@ -262,6 +268,9 @@

Method Details

"a_key": "A String", }, "createTime": "A String", # Output only. The timestamp when the resource was created. + "defaultFlagRevisions": [ # Optional. Default revisions of flags for this UnitKind. Newly created units will use the flag default_flag_revisions present at the time of creation. + "A String", + ], "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. { # Dependency represent a single dependency with another unit kind by alias. @@ -278,7 +287,7 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable @@ -296,13 +305,13 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable }, ], - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. Immutable once set. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. Immutable once set. "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. }
@@ -334,6 +343,9 @@

Method Details

"a_key": "A String", }, "createTime": "A String", # Output only. The timestamp when the resource was created. + "defaultFlagRevisions": [ # Optional. Default revisions of flags for this UnitKind. Newly created units will use the flag default_flag_revisions present at the time of creation. + "A String", + ], "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. { # Dependency represent a single dependency with another unit kind by alias. @@ -350,7 +362,7 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable @@ -368,13 +380,13 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable }, ], - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. Immutable once set. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. Immutable once set. "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. }, @@ -413,6 +425,9 @@

Method Details

"a_key": "A String", }, "createTime": "A String", # Output only. The timestamp when the resource was created. + "defaultFlagRevisions": [ # Optional. Default revisions of flags for this UnitKind. Newly created units will use the flag default_flag_revisions present at the time of creation. + "A String", + ], "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. { # Dependency represent a single dependency with another unit kind by alias. @@ -429,7 +444,7 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable @@ -447,13 +462,13 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable }, ], - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. Immutable once set. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. Immutable once set. "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. } @@ -474,6 +489,9 @@

Method Details

"a_key": "A String", }, "createTime": "A String", # Output only. The timestamp when the resource was created. + "defaultFlagRevisions": [ # Optional. Default revisions of flags for this UnitKind. Newly created units will use the flag default_flag_revisions present at the time of creation. + "A String", + ], "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. { # Dependency represent a single dependency with another unit kind by alias. @@ -490,7 +508,7 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable @@ -508,13 +526,13 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable }, ], - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. Immutable once set. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. Immutable once set. "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_v1.projects.locations.unitOperations.html b/docs/dyn/saasservicemgmt_v1.projects.locations.unitOperations.html index 23533516b7..b5f3da1357 100644 --- a/docs/dyn/saasservicemgmt_v1.projects.locations.unitOperations.html +++ b/docs/dyn/saasservicemgmt_v1.projects.locations.unitOperations.html @@ -72,7 +72,7 @@ -

SaaS Runtime API . projects . locations . unitOperations

+

App Lifecycle Manager API . projects . locations . unitOperations

Instance Methods

close()

@@ -131,6 +131,9 @@

Method Details

"engineState": "A String", # Optional. Output only. The engine state for on-going deployment engine operation(s). This field is opaque for external usage. "errorCategory": "A String", # Optional. Output only. UnitOperationErrorCategory describe the error category. "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. + "flagUpdate": { # FlagUpdate is a UnitOperation that pushes new flag values to Units. + "flagRelease": "A String", # Required. Flag release being applied by UnitOperation. + }, "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, @@ -198,6 +201,9 @@

Method Details

"engineState": "A String", # Optional. Output only. The engine state for on-going deployment engine operation(s). This field is opaque for external usage. "errorCategory": "A String", # Optional. Output only. UnitOperationErrorCategory describe the error category. "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. + "flagUpdate": { # FlagUpdate is a UnitOperation that pushes new flag values to Units. + "flagRelease": "A String", # Required. Flag release being applied by UnitOperation. + }, "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, @@ -290,6 +296,9 @@

Method Details

"engineState": "A String", # Optional. Output only. The engine state for on-going deployment engine operation(s). This field is opaque for external usage. "errorCategory": "A String", # Optional. Output only. UnitOperationErrorCategory describe the error category. "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. + "flagUpdate": { # FlagUpdate is a UnitOperation that pushes new flag values to Units. + "flagRelease": "A String", # Required. Flag release being applied by UnitOperation. + }, "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, @@ -368,6 +377,9 @@

Method Details

"engineState": "A String", # Optional. Output only. The engine state for on-going deployment engine operation(s). This field is opaque for external usage. "errorCategory": "A String", # Optional. Output only. UnitOperationErrorCategory describe the error category. "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. + "flagUpdate": { # FlagUpdate is a UnitOperation that pushes new flag values to Units. + "flagRelease": "A String", # Required. Flag release being applied by UnitOperation. + }, "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, @@ -453,6 +465,9 @@

Method Details

"engineState": "A String", # Optional. Output only. The engine state for on-going deployment engine operation(s). This field is opaque for external usage. "errorCategory": "A String", # Optional. Output only. UnitOperationErrorCategory describe the error category. "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. + "flagUpdate": { # FlagUpdate is a UnitOperation that pushes new flag values to Units. + "flagRelease": "A String", # Required. Flag release being applied by UnitOperation. + }, "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, @@ -520,6 +535,9 @@

Method Details

"engineState": "A String", # Optional. Output only. The engine state for on-going deployment engine operation(s). This field is opaque for external usage. "errorCategory": "A String", # Optional. Output only. UnitOperationErrorCategory describe the error category. "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. + "flagUpdate": { # FlagUpdate is a UnitOperation that pushes new flag values to Units. + "flagRelease": "A String", # Required. Flag release being applied by UnitOperation. + }, "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, diff --git a/docs/dyn/saasservicemgmt_v1.projects.locations.units.html b/docs/dyn/saasservicemgmt_v1.projects.locations.units.html index dcfd6fa6ed..d7ab3fea96 100644 --- a/docs/dyn/saasservicemgmt_v1.projects.locations.units.html +++ b/docs/dyn/saasservicemgmt_v1.projects.locations.units.html @@ -72,7 +72,7 @@ -

SaaS Runtime API . projects . locations . units

+

App Lifecycle Manager API . projects . locations . units

Instance Methods

close()

@@ -137,6 +137,9 @@

Method Details

}, ], "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. + "flagRevisions": [ # Optional. Output only. Flag revisions used by this Unit. + "A String", + ], "inputVariables": [ # Optional. Output only. Indicates the current input variables deployed by the unit { # UnitVariable describes a parameter for a Unit. "type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool. @@ -218,6 +221,9 @@

Method Details

}, ], "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. + "flagRevisions": [ # Optional. Output only. Flag revisions used by this Unit. + "A String", + ], "inputVariables": [ # Optional. Output only. Indicates the current input variables deployed by the unit { # UnitVariable describes a parameter for a Unit. "type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool. @@ -324,6 +330,9 @@

Method Details

}, ], "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. + "flagRevisions": [ # Optional. Output only. Flag revisions used by this Unit. + "A String", + ], "inputVariables": [ # Optional. Output only. Indicates the current input variables deployed by the unit { # UnitVariable describes a parameter for a Unit. "type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool. @@ -416,6 +425,9 @@

Method Details

}, ], "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. + "flagRevisions": [ # Optional. Output only. Flag revisions used by this Unit. + "A String", + ], "inputVariables": [ # Optional. Output only. Indicates the current input variables deployed by the unit { # UnitVariable describes a parameter for a Unit. "type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool. @@ -515,6 +527,9 @@

Method Details

}, ], "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. + "flagRevisions": [ # Optional. Output only. Flag revisions used by this Unit. + "A String", + ], "inputVariables": [ # Optional. Output only. Indicates the current input variables deployed by the unit { # UnitVariable describes a parameter for a Unit. "type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool. @@ -596,6 +611,9 @@

Method Details

}, ], "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. + "flagRevisions": [ # Optional. Output only. Flag revisions used by this Unit. + "A String", + ], "inputVariables": [ # Optional. Output only. Indicates the current input variables deployed by the unit { # UnitVariable describes a parameter for a Unit. "type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool. diff --git a/docs/dyn/saasservicemgmt_v1beta1.html b/docs/dyn/saasservicemgmt_v1beta1.html index 757f2f860b..dd752e1c0e 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.html +++ b/docs/dyn/saasservicemgmt_v1beta1.html @@ -72,7 +72,7 @@ -

SaaS Runtime API

+

App Lifecycle Manager API

Instance Methods

projects() diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.html b/docs/dyn/saasservicemgmt_v1beta1.projects.html index d286eba27d..407ce29151 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.html @@ -72,7 +72,7 @@ -

SaaS Runtime API . projects

+

App Lifecycle Manager API . projects

Instance Methods

locations() diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.flagAttributes.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.flagAttributes.html new file mode 100644 index 0000000000..f8231af508 --- /dev/null +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.flagAttributes.html @@ -0,0 +1,325 @@ + + + +

App Lifecycle Manager API . projects . locations . flagAttributes

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Create a new flag attribute.

+

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

+

Delete a single flag attribute.

+

+ get(name, x__xgafv=None)

+

Retrieve a single flag attribute.

+

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

+

Retrieve a collection of flag attributes.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Update a single flag attribute.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, flagAttributeId=None, requestId=None, validateOnly=None, x__xgafv=None) +
Create a new flag attribute.
+
+Args:
+  parent: string, Required. The parent of the flag attribute. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # FlagAttribute defines a custom property in the evaluation context.
+  "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",
+  },
+  "attributeValueType": "A String", # Optional. Immutable. Type of the attribute.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "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.
+  "key": "A String", # Required. Immutable. The identifier for the attribute, used as the key in the evaluation context. The attribute key is referenced in the evaluation rules and used in the OpenFeature evaluation API to specify the attribute context.
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagAttributes/{flag_attribute_id}"
+  "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.
+  "valueType": "A String", # Optional. Immutable. Deprecated: Use `attribute_value_type` instead. Type of the attribute.
+}
+
+  flagAttributeId: string, Required. The ID value for the new flag attribute.
+  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. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  validateOnly: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # FlagAttribute defines a custom property in the evaluation context.
+  "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",
+  },
+  "attributeValueType": "A String", # Optional. Immutable. Type of the attribute.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "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.
+  "key": "A String", # Required. Immutable. The identifier for the attribute, used as the key in the evaluation context. The attribute key is referenced in the evaluation rules and used in the OpenFeature evaluation API to specify the attribute context.
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagAttributes/{flag_attribute_id}"
+  "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.
+  "valueType": "A String", # Optional. Immutable. Deprecated: Use `attribute_value_type` instead. Type of the attribute.
+}
+
+ +
+ delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None) +
Delete a single flag attribute.
+
+Args:
+  name: string, Required. The resource name of the resource within a service. (required)
+  etag: string, The etag known to the client for the expected state of the flag attribute. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the flag attribute. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.
+  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. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  validateOnly: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Retrieve a single flag attribute.
+
+Args:
+  name: string, Required. The resource name of the resource within a service. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # FlagAttribute defines a custom property in the evaluation context.
+  "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",
+  },
+  "attributeValueType": "A String", # Optional. Immutable. Type of the attribute.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "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.
+  "key": "A String", # Required. Immutable. The identifier for the attribute, used as the key in the evaluation context. The attribute key is referenced in the evaluation rules and used in the OpenFeature evaluation API to specify the attribute context.
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagAttributes/{flag_attribute_id}"
+  "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.
+  "valueType": "A String", # Optional. Immutable. Deprecated: Use `attribute_value_type` instead. Type of the attribute.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Retrieve a collection of flag attributes.
+
+Args:
+  parent: string, Required. The parent of the flag attribute. (required)
+  filter: string, Filter the list as specified in https://google.aip.dev/160.
+  orderBy: string, Order results as specified in https://google.aip.dev/132.
+  pageSize: integer, The maximum number of flag attributes to send per page.
+  pageToken: string, The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response structure for the ListFlagAttributes method.
+  "flagAttributes": [ # The resulting flag attributes.
+    { # FlagAttribute defines a custom property in the evaluation context.
+      "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",
+      },
+      "attributeValueType": "A String", # Optional. Immutable. Type of the attribute.
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "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.
+      "key": "A String", # Required. Immutable. The identifier for the attribute, used as the key in the evaluation context. The attribute key is referenced in the evaluation rules and used in the OpenFeature evaluation API to specify the attribute context.
+      "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagAttributes/{flag_attribute_id}"
+      "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.
+      "valueType": "A String", # Optional. Immutable. Deprecated: Use `attribute_value_type` instead. Type of the attribute.
+    },
+  ],
+  "nextPageToken": "A String", # If present, the next page token can be provided to a subsequent ListFlagAttributes call to list the next page. If empty, there are no more pages.
+  "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, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None) +
Update a single flag attribute.
+
+Args:
+  name: string, Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagAttributes/{flag_attribute_id}" (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # FlagAttribute defines a custom property in the evaluation context.
+  "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",
+  },
+  "attributeValueType": "A String", # Optional. Immutable. Type of the attribute.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "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.
+  "key": "A String", # Required. Immutable. The identifier for the attribute, used as the key in the evaluation context. The attribute key is referenced in the evaluation rules and used in the OpenFeature evaluation API to specify the attribute context.
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagAttributes/{flag_attribute_id}"
+  "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.
+  "valueType": "A String", # Optional. Immutable. Deprecated: Use `attribute_value_type` instead. Type of the attribute.
+}
+
+  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. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  updateMask: string, Field mask is used to specify the fields to be overwritten in the FlagAttribute 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 in the FlagAttribute will be overwritten.
+  validateOnly: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # FlagAttribute defines a custom property in the evaluation context.
+  "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",
+  },
+  "attributeValueType": "A String", # Optional. Immutable. Type of the attribute.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "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.
+  "key": "A String", # Required. Immutable. The identifier for the attribute, used as the key in the evaluation context. The attribute key is referenced in the evaluation rules and used in the OpenFeature evaluation API to specify the attribute context.
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagAttributes/{flag_attribute_id}"
+  "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.
+  "valueType": "A String", # Optional. Immutable. Deprecated: Use `attribute_value_type` instead. Type of the attribute.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.flagReleases.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.flagReleases.html new file mode 100644 index 0000000000..529eeb2338 --- /dev/null +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.flagReleases.html @@ -0,0 +1,457 @@ + + + +

App Lifecycle Manager API . projects . locations . flagReleases

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Create a new flag release.

+

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

+

Delete a single flag release.

+

+ get(name, x__xgafv=None)

+

Retrieve a single flag release.

+

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

+

Retrieve a collection of flag releases.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Update a single flag release.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, flagReleaseId=None, requestId=None, validateOnly=None, x__xgafv=None) +
Create a new flag release.
+
+Args:
+  parent: string, Required. The parent of the flag release. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A collection of FlagRevisions.
+  "allFlags": True or False, # Optional. Immutable. DEPRECATED: Use all_flags_release instead. Rollout all flags in the provided UnitKind. Only one of flag_revisions, all_flags, or flag_sets can be set.
+  "allFlagsRelease": True or False, # Optional. Immutable. Specifies the release includes all flags.
+  "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",
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "effectiveFlagRevisions": [ # Output only. An OUTPUT_ONLY field that contains FlagRevisions to be rolled out. This is the ultimate source of truth of what a Rollout or a UnitOperation carries.
+    "A String",
+  ],
+  "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.
+  "flagRevisions": [ # Optional. Immutable. DEPRECATED: Use flag_revisions_release instead. FlagRevisions to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. It used to be the ultimate source to truth and has been moved to effective_flag_revisions.
+    "A String",
+  ],
+  "flagRevisionsRelease": { # Wrapper for a list of flag revisions. # Optional. Immutable. Specifies the release consists of a list of flag revisions.
+    "revisions": [ # Required. FlagRevisions to be rolled out.
+      "A String",
+    ],
+  },
+  "flagSets": [ # Optional. Immutable. DEPRECATED: Use flag_sets_release instead. Flag sets to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set.
+    "A String",
+  ],
+  "flagSetsRelease": { # Wrapper for a list of flag sets. # Optional. Immutable. Specifies the release consists of a list of flag sets.
+    "sets": [ # Required. Flag sets to be rolled out.
+      "A String",
+    ],
+  },
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagReleases/{flag_release_id}"
+  "obsoleteFlags": [ # Optional. Immutable. Deprecated: Use the 'state' field in the 'Flag' resource to manage the cleanup of flag lifecycles including removal from UnitKind and Units. Flags to be removed from given UnitKind and all related Units. If Flag is provided here, its FlagRevisions will be removed from UnitKind and Units.
+    "A String",
+  ],
+  "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.
+  "unitKind": "A String", # Required. Immutable. The UnitKind this FlagRelease applies to.
+  "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.
+}
+
+  flagReleaseId: string, Required. The ID value for the new flag release.
+  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. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  validateOnly: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A collection of FlagRevisions.
+  "allFlags": True or False, # Optional. Immutable. DEPRECATED: Use all_flags_release instead. Rollout all flags in the provided UnitKind. Only one of flag_revisions, all_flags, or flag_sets can be set.
+  "allFlagsRelease": True or False, # Optional. Immutable. Specifies the release includes all flags.
+  "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",
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "effectiveFlagRevisions": [ # Output only. An OUTPUT_ONLY field that contains FlagRevisions to be rolled out. This is the ultimate source of truth of what a Rollout or a UnitOperation carries.
+    "A String",
+  ],
+  "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.
+  "flagRevisions": [ # Optional. Immutable. DEPRECATED: Use flag_revisions_release instead. FlagRevisions to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. It used to be the ultimate source to truth and has been moved to effective_flag_revisions.
+    "A String",
+  ],
+  "flagRevisionsRelease": { # Wrapper for a list of flag revisions. # Optional. Immutable. Specifies the release consists of a list of flag revisions.
+    "revisions": [ # Required. FlagRevisions to be rolled out.
+      "A String",
+    ],
+  },
+  "flagSets": [ # Optional. Immutable. DEPRECATED: Use flag_sets_release instead. Flag sets to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set.
+    "A String",
+  ],
+  "flagSetsRelease": { # Wrapper for a list of flag sets. # Optional. Immutable. Specifies the release consists of a list of flag sets.
+    "sets": [ # Required. Flag sets to be rolled out.
+      "A String",
+    ],
+  },
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagReleases/{flag_release_id}"
+  "obsoleteFlags": [ # Optional. Immutable. Deprecated: Use the 'state' field in the 'Flag' resource to manage the cleanup of flag lifecycles including removal from UnitKind and Units. Flags to be removed from given UnitKind and all related Units. If Flag is provided here, its FlagRevisions will be removed from UnitKind and Units.
+    "A String",
+  ],
+  "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.
+  "unitKind": "A String", # Required. Immutable. The UnitKind this FlagRelease applies to.
+  "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.
+}
+
+ +
+ delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None) +
Delete a single flag release.
+
+Args:
+  name: string, Required. The resource name of the resource within a service. (required)
+  etag: string, The etag known to the client for the expected state of the flag release. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the flag release. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.
+  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. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  validateOnly: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Retrieve a single flag release.
+
+Args:
+  name: string, Required. The resource name of the resource within a service. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A collection of FlagRevisions.
+  "allFlags": True or False, # Optional. Immutable. DEPRECATED: Use all_flags_release instead. Rollout all flags in the provided UnitKind. Only one of flag_revisions, all_flags, or flag_sets can be set.
+  "allFlagsRelease": True or False, # Optional. Immutable. Specifies the release includes all flags.
+  "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",
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "effectiveFlagRevisions": [ # Output only. An OUTPUT_ONLY field that contains FlagRevisions to be rolled out. This is the ultimate source of truth of what a Rollout or a UnitOperation carries.
+    "A String",
+  ],
+  "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.
+  "flagRevisions": [ # Optional. Immutable. DEPRECATED: Use flag_revisions_release instead. FlagRevisions to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. It used to be the ultimate source to truth and has been moved to effective_flag_revisions.
+    "A String",
+  ],
+  "flagRevisionsRelease": { # Wrapper for a list of flag revisions. # Optional. Immutable. Specifies the release consists of a list of flag revisions.
+    "revisions": [ # Required. FlagRevisions to be rolled out.
+      "A String",
+    ],
+  },
+  "flagSets": [ # Optional. Immutable. DEPRECATED: Use flag_sets_release instead. Flag sets to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set.
+    "A String",
+  ],
+  "flagSetsRelease": { # Wrapper for a list of flag sets. # Optional. Immutable. Specifies the release consists of a list of flag sets.
+    "sets": [ # Required. Flag sets to be rolled out.
+      "A String",
+    ],
+  },
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagReleases/{flag_release_id}"
+  "obsoleteFlags": [ # Optional. Immutable. Deprecated: Use the 'state' field in the 'Flag' resource to manage the cleanup of flag lifecycles including removal from UnitKind and Units. Flags to be removed from given UnitKind and all related Units. If Flag is provided here, its FlagRevisions will be removed from UnitKind and Units.
+    "A String",
+  ],
+  "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.
+  "unitKind": "A String", # Required. Immutable. The UnitKind this FlagRelease applies to.
+  "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.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Retrieve a collection of flag releases.
+
+Args:
+  parent: string, Required. The parent of the flag release. (required)
+  filter: string, Filter the list as specified in https://google.aip.dev/160.
+  orderBy: string, Order results as specified in https://google.aip.dev/132.
+  pageSize: integer, The maximum number of flag releases to send per page.
+  pageToken: string, The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response structure for the ListFlagReleases method.
+  "flagReleases": [ # The resulting flag releases.
+    { # A collection of FlagRevisions.
+      "allFlags": True or False, # Optional. Immutable. DEPRECATED: Use all_flags_release instead. Rollout all flags in the provided UnitKind. Only one of flag_revisions, all_flags, or flag_sets can be set.
+      "allFlagsRelease": True or False, # Optional. Immutable. Specifies the release includes all flags.
+      "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",
+      },
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "effectiveFlagRevisions": [ # Output only. An OUTPUT_ONLY field that contains FlagRevisions to be rolled out. This is the ultimate source of truth of what a Rollout or a UnitOperation carries.
+        "A String",
+      ],
+      "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.
+      "flagRevisions": [ # Optional. Immutable. DEPRECATED: Use flag_revisions_release instead. FlagRevisions to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. It used to be the ultimate source to truth and has been moved to effective_flag_revisions.
+        "A String",
+      ],
+      "flagRevisionsRelease": { # Wrapper for a list of flag revisions. # Optional. Immutable. Specifies the release consists of a list of flag revisions.
+        "revisions": [ # Required. FlagRevisions to be rolled out.
+          "A String",
+        ],
+      },
+      "flagSets": [ # Optional. Immutable. DEPRECATED: Use flag_sets_release instead. Flag sets to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set.
+        "A String",
+      ],
+      "flagSetsRelease": { # Wrapper for a list of flag sets. # Optional. Immutable. Specifies the release consists of a list of flag sets.
+        "sets": [ # Required. Flag sets to be rolled out.
+          "A String",
+        ],
+      },
+      "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagReleases/{flag_release_id}"
+      "obsoleteFlags": [ # Optional. Immutable. Deprecated: Use the 'state' field in the 'Flag' resource to manage the cleanup of flag lifecycles including removal from UnitKind and Units. Flags to be removed from given UnitKind and all related Units. If Flag is provided here, its FlagRevisions will be removed from UnitKind and Units.
+        "A String",
+      ],
+      "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.
+      "unitKind": "A String", # Required. Immutable. The UnitKind this FlagRelease applies to.
+      "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.
+    },
+  ],
+  "nextPageToken": "A String", # If present, the next page token can be provided to a subsequent ListFlagReleases call to list the next page. If empty, there are no more pages.
+  "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, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None) +
Update a single flag release.
+
+Args:
+  name: string, Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagReleases/{flag_release_id}" (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A collection of FlagRevisions.
+  "allFlags": True or False, # Optional. Immutable. DEPRECATED: Use all_flags_release instead. Rollout all flags in the provided UnitKind. Only one of flag_revisions, all_flags, or flag_sets can be set.
+  "allFlagsRelease": True or False, # Optional. Immutable. Specifies the release includes all flags.
+  "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",
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "effectiveFlagRevisions": [ # Output only. An OUTPUT_ONLY field that contains FlagRevisions to be rolled out. This is the ultimate source of truth of what a Rollout or a UnitOperation carries.
+    "A String",
+  ],
+  "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.
+  "flagRevisions": [ # Optional. Immutable. DEPRECATED: Use flag_revisions_release instead. FlagRevisions to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. It used to be the ultimate source to truth and has been moved to effective_flag_revisions.
+    "A String",
+  ],
+  "flagRevisionsRelease": { # Wrapper for a list of flag revisions. # Optional. Immutable. Specifies the release consists of a list of flag revisions.
+    "revisions": [ # Required. FlagRevisions to be rolled out.
+      "A String",
+    ],
+  },
+  "flagSets": [ # Optional. Immutable. DEPRECATED: Use flag_sets_release instead. Flag sets to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set.
+    "A String",
+  ],
+  "flagSetsRelease": { # Wrapper for a list of flag sets. # Optional. Immutable. Specifies the release consists of a list of flag sets.
+    "sets": [ # Required. Flag sets to be rolled out.
+      "A String",
+    ],
+  },
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagReleases/{flag_release_id}"
+  "obsoleteFlags": [ # Optional. Immutable. Deprecated: Use the 'state' field in the 'Flag' resource to manage the cleanup of flag lifecycles including removal from UnitKind and Units. Flags to be removed from given UnitKind and all related Units. If Flag is provided here, its FlagRevisions will be removed from UnitKind and Units.
+    "A String",
+  ],
+  "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.
+  "unitKind": "A String", # Required. Immutable. The UnitKind this FlagRelease applies to.
+  "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.
+}
+
+  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. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  updateMask: string, Field mask is used to specify the fields to be overwritten in the FlagRelease 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 in the FlagRelease will be overwritten.
+  validateOnly: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A collection of FlagRevisions.
+  "allFlags": True or False, # Optional. Immutable. DEPRECATED: Use all_flags_release instead. Rollout all flags in the provided UnitKind. Only one of flag_revisions, all_flags, or flag_sets can be set.
+  "allFlagsRelease": True or False, # Optional. Immutable. Specifies the release includes all flags.
+  "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",
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "effectiveFlagRevisions": [ # Output only. An OUTPUT_ONLY field that contains FlagRevisions to be rolled out. This is the ultimate source of truth of what a Rollout or a UnitOperation carries.
+    "A String",
+  ],
+  "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.
+  "flagRevisions": [ # Optional. Immutable. DEPRECATED: Use flag_revisions_release instead. FlagRevisions to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. It used to be the ultimate source to truth and has been moved to effective_flag_revisions.
+    "A String",
+  ],
+  "flagRevisionsRelease": { # Wrapper for a list of flag revisions. # Optional. Immutable. Specifies the release consists of a list of flag revisions.
+    "revisions": [ # Required. FlagRevisions to be rolled out.
+      "A String",
+    ],
+  },
+  "flagSets": [ # Optional. Immutable. DEPRECATED: Use flag_sets_release instead. Flag sets to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set.
+    "A String",
+  ],
+  "flagSetsRelease": { # Wrapper for a list of flag sets. # Optional. Immutable. Specifies the release consists of a list of flag sets.
+    "sets": [ # Required. Flag sets to be rolled out.
+      "A String",
+    ],
+  },
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagReleases/{flag_release_id}"
+  "obsoleteFlags": [ # Optional. Immutable. Deprecated: Use the 'state' field in the 'Flag' resource to manage the cleanup of flag lifecycles including removal from UnitKind and Units. Flags to be removed from given UnitKind and all related Units. If Flag is provided here, its FlagRevisions will be removed from UnitKind and Units.
+    "A String",
+  ],
+  "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.
+  "unitKind": "A String", # Required. Immutable. The UnitKind this FlagRelease applies to.
+  "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.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.flagRevisions.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.flagRevisions.html new file mode 100644 index 0000000000..8cb391d297 --- /dev/null +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.flagRevisions.html @@ -0,0 +1,919 @@ + + + +

App Lifecycle Manager API . projects . locations . flagRevisions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Create a new flag revision.

+

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

+

Delete a single flag revision.

+

+ get(name, x__xgafv=None)

+

Retrieve a single flag revision.

+

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

+

Retrieve a collection of flag revisions.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Update a single flag revision.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, flagRevisionId=None, requestId=None, validateOnly=None, x__xgafv=None) +
Create a new flag revision.
+
+Args:
+  parent: string, Required. The parent of the flag revision. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A snapshot of the EvaluationSpec for the Flag.
+  "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",
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "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.
+  "evaluationSpec": { # EvaluationSpec holds rules for evaluating the value of a flag. # Output only. Immutable. Snapshot of the EvaluationSpec for the flag. DEPRECATED: Use snapshot instead.
+    "allocations": [ # Optional. A list of allocations.
+      { # Allocation defines a set of weighted flag variants, specifying how traffic is split based on the randomization unit.
+        "description": "A String", # Optional. Description of the allocation. Max length: 500 bytes.
+        "id": "A String", # Required. Allocation ID. Max length: 128 bytes.
+        "randomizedOn": "A String", # Required. Key of the context attribute that is used for traffic splitting.
+        "slots": [ # Required. Slots defines the weighted distribution of variants.
+          { # AllocationSlot specifies a variant and the proportion of traffic allocated to it.
+            "variant": "A String", # Required. Variant of the allocation slot.
+            "weight": 42, # Required. Weight defines the proportion of traffic to allocate to the variant, relative to other slots in the same allocation.
+          },
+        ],
+      },
+    ],
+    "attributes": [ # Optional. Names of the context attributes that are used in the evaluation rules and allocations.
+      "A String",
+    ],
+    "defaultTarget": "A String", # Required. Default variant or allocation of the flag.
+    "rules": [ # Optional. Evaluation rules define the logic for evaluating the flag against a given context. The rules are evaluated sequentially in their specified order.
+      { # EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user.
+        "condition": "A String", # Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied.
+        "id": "A String", # Required. Evaluation rule ID. Max length: 128 bytes.
+        "target": "A String", # Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.
+      },
+    ],
+    "variants": [ # Optional. A list of variants.
+      { # Variant is an identifier for a value (name assigned to a value). DEPRECATED: Use Flag.Variants instead.
+        "boolValue": True or False, # Optional. Boolean flag value.
+        "doubleValue": 3.14, # Optional. Double flag value.
+        "intValue": "A String", # Optional. Integer flag value.
+        "name": "A String", # Required. Name of the variant. Max length: 128 bytes.
+        "stringValue": "A String", # Optional. String flag value.
+      },
+    ],
+  },
+  "flag": "A String", # Required. Immutable. Name of the Flag this is a revision of.
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagRevisions/{flag_revision_id}"
+  "snapshot": { # Represents a single Flag. # Output only. Immutable. Snapshot of the Flag.
+    "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",
+    },
+    "createTime": "A String", # Output only. The timestamp when the resource was created.
+    "description": "A String", # Optional. Description of the flag. Max length: 500 bytes.
+    "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.
+    "evaluationSpec": { # EvaluationSpec holds rules for evaluating the value of a flag. # Optional. Specification of how the flag value should be evaluated. If a bool flag is created without an evaluation_spec specified, two default variants, "Enabled" (with bool_value = true) and "Disabled" (with bool_value = false), are created by default, and "Disabled" is set as the default_target.
+      "allocations": [ # Optional. A list of allocations.
+        { # Allocation defines a set of weighted flag variants, specifying how traffic is split based on the randomization unit.
+          "description": "A String", # Optional. Description of the allocation. Max length: 500 bytes.
+          "id": "A String", # Required. Allocation ID. Max length: 128 bytes.
+          "randomizedOn": "A String", # Required. Key of the context attribute that is used for traffic splitting.
+          "slots": [ # Required. Slots defines the weighted distribution of variants.
+            { # AllocationSlot specifies a variant and the proportion of traffic allocated to it.
+              "variant": "A String", # Required. Variant of the allocation slot.
+              "weight": 42, # Required. Weight defines the proportion of traffic to allocate to the variant, relative to other slots in the same allocation.
+            },
+          ],
+        },
+      ],
+      "attributes": [ # Optional. Names of the context attributes that are used in the evaluation rules and allocations.
+        "A String",
+      ],
+      "defaultTarget": "A String", # Required. Default variant or allocation of the flag.
+      "rules": [ # Optional. Evaluation rules define the logic for evaluating the flag against a given context. The rules are evaluated sequentially in their specified order.
+        { # EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user.
+          "condition": "A String", # Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied.
+          "id": "A String", # Required. Evaluation rule ID. Max length: 128 bytes.
+          "target": "A String", # Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.
+        },
+      ],
+      "variants": [ # Optional. A list of variants.
+        { # Variant is an identifier for a value (name assigned to a value). DEPRECATED: Use Flag.Variants instead.
+          "boolValue": True or False, # Optional. Boolean flag value.
+          "doubleValue": 3.14, # Optional. Double flag value.
+          "intValue": "A String", # Optional. Integer flag value.
+          "name": "A String", # Required. Name of the variant. Max length: 128 bytes.
+          "stringValue": "A String", # Optional. String flag value.
+        },
+      ],
+    },
+    "flagSet": "A String", # Optional. Flag set this flag belongs to.
+    "flagValueType": "A String", # Optional. Immutable. Flag value type.
+    "key": "A String", # Required. Immutable. Flag key used in runtime evaluation APIs (OpenFeature). Max length: 256 bytes.
+    "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+      "a_key": "A String",
+    },
+    "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flags/{flag_id}"
+    "state": "A String", # Optional. Current state of the flag.
+    "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.
+    "unitKind": "A String", # Required. Immutable. UnitKind that can consume this flag.
+    "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.
+    "valueType": "A String", # Optional. Immutable. Deprecated: Use `flag_value_type` instead. Flag value type.
+    "variants": [ # Optional. A list of variants.
+      { # Variant is an identifier for a value (name assigned to a value).
+        "booleanValue": True or False, # Optional. Boolean variant value.
+        "description": "A String", # Optional. A human-readable description of what this variant does or represents.
+        "doubleValue": 3.14, # Optional. Double variant value.
+        "id": "A String", # Required. Variant ID. Max length: 128 bytes.
+        "integerValue": "A String", # Optional. Integer variant value.
+        "stringValue": "A String", # Optional. String variant value.
+        "trackingId": "A String", # Optional. trackingId is unique depending on name and value of the variant within the scope of the service. It is typically generated by the server and must not be changed. trackingId is used to uniquely identify and track variants.
+      },
+    ],
+  },
+  "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.
+}
+
+  flagRevisionId: string, Required. The ID value for the new flag revision.
+  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. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  validateOnly: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A snapshot of the EvaluationSpec for the Flag.
+  "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",
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "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.
+  "evaluationSpec": { # EvaluationSpec holds rules for evaluating the value of a flag. # Output only. Immutable. Snapshot of the EvaluationSpec for the flag. DEPRECATED: Use snapshot instead.
+    "allocations": [ # Optional. A list of allocations.
+      { # Allocation defines a set of weighted flag variants, specifying how traffic is split based on the randomization unit.
+        "description": "A String", # Optional. Description of the allocation. Max length: 500 bytes.
+        "id": "A String", # Required. Allocation ID. Max length: 128 bytes.
+        "randomizedOn": "A String", # Required. Key of the context attribute that is used for traffic splitting.
+        "slots": [ # Required. Slots defines the weighted distribution of variants.
+          { # AllocationSlot specifies a variant and the proportion of traffic allocated to it.
+            "variant": "A String", # Required. Variant of the allocation slot.
+            "weight": 42, # Required. Weight defines the proportion of traffic to allocate to the variant, relative to other slots in the same allocation.
+          },
+        ],
+      },
+    ],
+    "attributes": [ # Optional. Names of the context attributes that are used in the evaluation rules and allocations.
+      "A String",
+    ],
+    "defaultTarget": "A String", # Required. Default variant or allocation of the flag.
+    "rules": [ # Optional. Evaluation rules define the logic for evaluating the flag against a given context. The rules are evaluated sequentially in their specified order.
+      { # EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user.
+        "condition": "A String", # Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied.
+        "id": "A String", # Required. Evaluation rule ID. Max length: 128 bytes.
+        "target": "A String", # Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.
+      },
+    ],
+    "variants": [ # Optional. A list of variants.
+      { # Variant is an identifier for a value (name assigned to a value). DEPRECATED: Use Flag.Variants instead.
+        "boolValue": True or False, # Optional. Boolean flag value.
+        "doubleValue": 3.14, # Optional. Double flag value.
+        "intValue": "A String", # Optional. Integer flag value.
+        "name": "A String", # Required. Name of the variant. Max length: 128 bytes.
+        "stringValue": "A String", # Optional. String flag value.
+      },
+    ],
+  },
+  "flag": "A String", # Required. Immutable. Name of the Flag this is a revision of.
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagRevisions/{flag_revision_id}"
+  "snapshot": { # Represents a single Flag. # Output only. Immutable. Snapshot of the Flag.
+    "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",
+    },
+    "createTime": "A String", # Output only. The timestamp when the resource was created.
+    "description": "A String", # Optional. Description of the flag. Max length: 500 bytes.
+    "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.
+    "evaluationSpec": { # EvaluationSpec holds rules for evaluating the value of a flag. # Optional. Specification of how the flag value should be evaluated. If a bool flag is created without an evaluation_spec specified, two default variants, "Enabled" (with bool_value = true) and "Disabled" (with bool_value = false), are created by default, and "Disabled" is set as the default_target.
+      "allocations": [ # Optional. A list of allocations.
+        { # Allocation defines a set of weighted flag variants, specifying how traffic is split based on the randomization unit.
+          "description": "A String", # Optional. Description of the allocation. Max length: 500 bytes.
+          "id": "A String", # Required. Allocation ID. Max length: 128 bytes.
+          "randomizedOn": "A String", # Required. Key of the context attribute that is used for traffic splitting.
+          "slots": [ # Required. Slots defines the weighted distribution of variants.
+            { # AllocationSlot specifies a variant and the proportion of traffic allocated to it.
+              "variant": "A String", # Required. Variant of the allocation slot.
+              "weight": 42, # Required. Weight defines the proportion of traffic to allocate to the variant, relative to other slots in the same allocation.
+            },
+          ],
+        },
+      ],
+      "attributes": [ # Optional. Names of the context attributes that are used in the evaluation rules and allocations.
+        "A String",
+      ],
+      "defaultTarget": "A String", # Required. Default variant or allocation of the flag.
+      "rules": [ # Optional. Evaluation rules define the logic for evaluating the flag against a given context. The rules are evaluated sequentially in their specified order.
+        { # EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user.
+          "condition": "A String", # Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied.
+          "id": "A String", # Required. Evaluation rule ID. Max length: 128 bytes.
+          "target": "A String", # Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.
+        },
+      ],
+      "variants": [ # Optional. A list of variants.
+        { # Variant is an identifier for a value (name assigned to a value). DEPRECATED: Use Flag.Variants instead.
+          "boolValue": True or False, # Optional. Boolean flag value.
+          "doubleValue": 3.14, # Optional. Double flag value.
+          "intValue": "A String", # Optional. Integer flag value.
+          "name": "A String", # Required. Name of the variant. Max length: 128 bytes.
+          "stringValue": "A String", # Optional. String flag value.
+        },
+      ],
+    },
+    "flagSet": "A String", # Optional. Flag set this flag belongs to.
+    "flagValueType": "A String", # Optional. Immutable. Flag value type.
+    "key": "A String", # Required. Immutable. Flag key used in runtime evaluation APIs (OpenFeature). Max length: 256 bytes.
+    "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+      "a_key": "A String",
+    },
+    "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flags/{flag_id}"
+    "state": "A String", # Optional. Current state of the flag.
+    "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.
+    "unitKind": "A String", # Required. Immutable. UnitKind that can consume this flag.
+    "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.
+    "valueType": "A String", # Optional. Immutable. Deprecated: Use `flag_value_type` instead. Flag value type.
+    "variants": [ # Optional. A list of variants.
+      { # Variant is an identifier for a value (name assigned to a value).
+        "booleanValue": True or False, # Optional. Boolean variant value.
+        "description": "A String", # Optional. A human-readable description of what this variant does or represents.
+        "doubleValue": 3.14, # Optional. Double variant value.
+        "id": "A String", # Required. Variant ID. Max length: 128 bytes.
+        "integerValue": "A String", # Optional. Integer variant value.
+        "stringValue": "A String", # Optional. String variant value.
+        "trackingId": "A String", # Optional. trackingId is unique depending on name and value of the variant within the scope of the service. It is typically generated by the server and must not be changed. trackingId is used to uniquely identify and track variants.
+      },
+    ],
+  },
+  "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.
+}
+
+ +
+ delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None) +
Delete a single flag revision.
+
+Args:
+  name: string, Required. The resource name of the resource within a service. (required)
+  etag: string, The etag known to the client for the expected state of the flag revision. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the flag revision. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.
+  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. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  validateOnly: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Retrieve a single flag revision.
+
+Args:
+  name: string, Required. The resource name of the resource within a service. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A snapshot of the EvaluationSpec for the Flag.
+  "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",
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "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.
+  "evaluationSpec": { # EvaluationSpec holds rules for evaluating the value of a flag. # Output only. Immutable. Snapshot of the EvaluationSpec for the flag. DEPRECATED: Use snapshot instead.
+    "allocations": [ # Optional. A list of allocations.
+      { # Allocation defines a set of weighted flag variants, specifying how traffic is split based on the randomization unit.
+        "description": "A String", # Optional. Description of the allocation. Max length: 500 bytes.
+        "id": "A String", # Required. Allocation ID. Max length: 128 bytes.
+        "randomizedOn": "A String", # Required. Key of the context attribute that is used for traffic splitting.
+        "slots": [ # Required. Slots defines the weighted distribution of variants.
+          { # AllocationSlot specifies a variant and the proportion of traffic allocated to it.
+            "variant": "A String", # Required. Variant of the allocation slot.
+            "weight": 42, # Required. Weight defines the proportion of traffic to allocate to the variant, relative to other slots in the same allocation.
+          },
+        ],
+      },
+    ],
+    "attributes": [ # Optional. Names of the context attributes that are used in the evaluation rules and allocations.
+      "A String",
+    ],
+    "defaultTarget": "A String", # Required. Default variant or allocation of the flag.
+    "rules": [ # Optional. Evaluation rules define the logic for evaluating the flag against a given context. The rules are evaluated sequentially in their specified order.
+      { # EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user.
+        "condition": "A String", # Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied.
+        "id": "A String", # Required. Evaluation rule ID. Max length: 128 bytes.
+        "target": "A String", # Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.
+      },
+    ],
+    "variants": [ # Optional. A list of variants.
+      { # Variant is an identifier for a value (name assigned to a value). DEPRECATED: Use Flag.Variants instead.
+        "boolValue": True or False, # Optional. Boolean flag value.
+        "doubleValue": 3.14, # Optional. Double flag value.
+        "intValue": "A String", # Optional. Integer flag value.
+        "name": "A String", # Required. Name of the variant. Max length: 128 bytes.
+        "stringValue": "A String", # Optional. String flag value.
+      },
+    ],
+  },
+  "flag": "A String", # Required. Immutable. Name of the Flag this is a revision of.
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagRevisions/{flag_revision_id}"
+  "snapshot": { # Represents a single Flag. # Output only. Immutable. Snapshot of the Flag.
+    "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",
+    },
+    "createTime": "A String", # Output only. The timestamp when the resource was created.
+    "description": "A String", # Optional. Description of the flag. Max length: 500 bytes.
+    "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.
+    "evaluationSpec": { # EvaluationSpec holds rules for evaluating the value of a flag. # Optional. Specification of how the flag value should be evaluated. If a bool flag is created without an evaluation_spec specified, two default variants, "Enabled" (with bool_value = true) and "Disabled" (with bool_value = false), are created by default, and "Disabled" is set as the default_target.
+      "allocations": [ # Optional. A list of allocations.
+        { # Allocation defines a set of weighted flag variants, specifying how traffic is split based on the randomization unit.
+          "description": "A String", # Optional. Description of the allocation. Max length: 500 bytes.
+          "id": "A String", # Required. Allocation ID. Max length: 128 bytes.
+          "randomizedOn": "A String", # Required. Key of the context attribute that is used for traffic splitting.
+          "slots": [ # Required. Slots defines the weighted distribution of variants.
+            { # AllocationSlot specifies a variant and the proportion of traffic allocated to it.
+              "variant": "A String", # Required. Variant of the allocation slot.
+              "weight": 42, # Required. Weight defines the proportion of traffic to allocate to the variant, relative to other slots in the same allocation.
+            },
+          ],
+        },
+      ],
+      "attributes": [ # Optional. Names of the context attributes that are used in the evaluation rules and allocations.
+        "A String",
+      ],
+      "defaultTarget": "A String", # Required. Default variant or allocation of the flag.
+      "rules": [ # Optional. Evaluation rules define the logic for evaluating the flag against a given context. The rules are evaluated sequentially in their specified order.
+        { # EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user.
+          "condition": "A String", # Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied.
+          "id": "A String", # Required. Evaluation rule ID. Max length: 128 bytes.
+          "target": "A String", # Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.
+        },
+      ],
+      "variants": [ # Optional. A list of variants.
+        { # Variant is an identifier for a value (name assigned to a value). DEPRECATED: Use Flag.Variants instead.
+          "boolValue": True or False, # Optional. Boolean flag value.
+          "doubleValue": 3.14, # Optional. Double flag value.
+          "intValue": "A String", # Optional. Integer flag value.
+          "name": "A String", # Required. Name of the variant. Max length: 128 bytes.
+          "stringValue": "A String", # Optional. String flag value.
+        },
+      ],
+    },
+    "flagSet": "A String", # Optional. Flag set this flag belongs to.
+    "flagValueType": "A String", # Optional. Immutable. Flag value type.
+    "key": "A String", # Required. Immutable. Flag key used in runtime evaluation APIs (OpenFeature). Max length: 256 bytes.
+    "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+      "a_key": "A String",
+    },
+    "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flags/{flag_id}"
+    "state": "A String", # Optional. Current state of the flag.
+    "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.
+    "unitKind": "A String", # Required. Immutable. UnitKind that can consume this flag.
+    "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.
+    "valueType": "A String", # Optional. Immutable. Deprecated: Use `flag_value_type` instead. Flag value type.
+    "variants": [ # Optional. A list of variants.
+      { # Variant is an identifier for a value (name assigned to a value).
+        "booleanValue": True or False, # Optional. Boolean variant value.
+        "description": "A String", # Optional. A human-readable description of what this variant does or represents.
+        "doubleValue": 3.14, # Optional. Double variant value.
+        "id": "A String", # Required. Variant ID. Max length: 128 bytes.
+        "integerValue": "A String", # Optional. Integer variant value.
+        "stringValue": "A String", # Optional. String variant value.
+        "trackingId": "A String", # Optional. trackingId is unique depending on name and value of the variant within the scope of the service. It is typically generated by the server and must not be changed. trackingId is used to uniquely identify and track variants.
+      },
+    ],
+  },
+  "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.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Retrieve a collection of flag revisions.
+
+Args:
+  parent: string, Required. The parent of the flag revision. (required)
+  filter: string, Filter the list as specified in https://google.aip.dev/160.
+  orderBy: string, Order results as specified in https://google.aip.dev/132.
+  pageSize: integer, The maximum number of flag revisions to send per page.
+  pageToken: string, The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response structure for the ListFlagRevisions method.
+  "flagRevisions": [ # The resulting flag revisions.
+    { # A snapshot of the EvaluationSpec for the Flag.
+      "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",
+      },
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "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.
+      "evaluationSpec": { # EvaluationSpec holds rules for evaluating the value of a flag. # Output only. Immutable. Snapshot of the EvaluationSpec for the flag. DEPRECATED: Use snapshot instead.
+        "allocations": [ # Optional. A list of allocations.
+          { # Allocation defines a set of weighted flag variants, specifying how traffic is split based on the randomization unit.
+            "description": "A String", # Optional. Description of the allocation. Max length: 500 bytes.
+            "id": "A String", # Required. Allocation ID. Max length: 128 bytes.
+            "randomizedOn": "A String", # Required. Key of the context attribute that is used for traffic splitting.
+            "slots": [ # Required. Slots defines the weighted distribution of variants.
+              { # AllocationSlot specifies a variant and the proportion of traffic allocated to it.
+                "variant": "A String", # Required. Variant of the allocation slot.
+                "weight": 42, # Required. Weight defines the proportion of traffic to allocate to the variant, relative to other slots in the same allocation.
+              },
+            ],
+          },
+        ],
+        "attributes": [ # Optional. Names of the context attributes that are used in the evaluation rules and allocations.
+          "A String",
+        ],
+        "defaultTarget": "A String", # Required. Default variant or allocation of the flag.
+        "rules": [ # Optional. Evaluation rules define the logic for evaluating the flag against a given context. The rules are evaluated sequentially in their specified order.
+          { # EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user.
+            "condition": "A String", # Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied.
+            "id": "A String", # Required. Evaluation rule ID. Max length: 128 bytes.
+            "target": "A String", # Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.
+          },
+        ],
+        "variants": [ # Optional. A list of variants.
+          { # Variant is an identifier for a value (name assigned to a value). DEPRECATED: Use Flag.Variants instead.
+            "boolValue": True or False, # Optional. Boolean flag value.
+            "doubleValue": 3.14, # Optional. Double flag value.
+            "intValue": "A String", # Optional. Integer flag value.
+            "name": "A String", # Required. Name of the variant. Max length: 128 bytes.
+            "stringValue": "A String", # Optional. String flag value.
+          },
+        ],
+      },
+      "flag": "A String", # Required. Immutable. Name of the Flag this is a revision of.
+      "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagRevisions/{flag_revision_id}"
+      "snapshot": { # Represents a single Flag. # Output only. Immutable. Snapshot of the Flag.
+        "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",
+        },
+        "createTime": "A String", # Output only. The timestamp when the resource was created.
+        "description": "A String", # Optional. Description of the flag. Max length: 500 bytes.
+        "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.
+        "evaluationSpec": { # EvaluationSpec holds rules for evaluating the value of a flag. # Optional. Specification of how the flag value should be evaluated. If a bool flag is created without an evaluation_spec specified, two default variants, "Enabled" (with bool_value = true) and "Disabled" (with bool_value = false), are created by default, and "Disabled" is set as the default_target.
+          "allocations": [ # Optional. A list of allocations.
+            { # Allocation defines a set of weighted flag variants, specifying how traffic is split based on the randomization unit.
+              "description": "A String", # Optional. Description of the allocation. Max length: 500 bytes.
+              "id": "A String", # Required. Allocation ID. Max length: 128 bytes.
+              "randomizedOn": "A String", # Required. Key of the context attribute that is used for traffic splitting.
+              "slots": [ # Required. Slots defines the weighted distribution of variants.
+                { # AllocationSlot specifies a variant and the proportion of traffic allocated to it.
+                  "variant": "A String", # Required. Variant of the allocation slot.
+                  "weight": 42, # Required. Weight defines the proportion of traffic to allocate to the variant, relative to other slots in the same allocation.
+                },
+              ],
+            },
+          ],
+          "attributes": [ # Optional. Names of the context attributes that are used in the evaluation rules and allocations.
+            "A String",
+          ],
+          "defaultTarget": "A String", # Required. Default variant or allocation of the flag.
+          "rules": [ # Optional. Evaluation rules define the logic for evaluating the flag against a given context. The rules are evaluated sequentially in their specified order.
+            { # EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user.
+              "condition": "A String", # Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied.
+              "id": "A String", # Required. Evaluation rule ID. Max length: 128 bytes.
+              "target": "A String", # Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.
+            },
+          ],
+          "variants": [ # Optional. A list of variants.
+            { # Variant is an identifier for a value (name assigned to a value). DEPRECATED: Use Flag.Variants instead.
+              "boolValue": True or False, # Optional. Boolean flag value.
+              "doubleValue": 3.14, # Optional. Double flag value.
+              "intValue": "A String", # Optional. Integer flag value.
+              "name": "A String", # Required. Name of the variant. Max length: 128 bytes.
+              "stringValue": "A String", # Optional. String flag value.
+            },
+          ],
+        },
+        "flagSet": "A String", # Optional. Flag set this flag belongs to.
+        "flagValueType": "A String", # Optional. Immutable. Flag value type.
+        "key": "A String", # Required. Immutable. Flag key used in runtime evaluation APIs (OpenFeature). Max length: 256 bytes.
+        "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+          "a_key": "A String",
+        },
+        "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flags/{flag_id}"
+        "state": "A String", # Optional. Current state of the flag.
+        "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.
+        "unitKind": "A String", # Required. Immutable. UnitKind that can consume this flag.
+        "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.
+        "valueType": "A String", # Optional. Immutable. Deprecated: Use `flag_value_type` instead. Flag value type.
+        "variants": [ # Optional. A list of variants.
+          { # Variant is an identifier for a value (name assigned to a value).
+            "booleanValue": True or False, # Optional. Boolean variant value.
+            "description": "A String", # Optional. A human-readable description of what this variant does or represents.
+            "doubleValue": 3.14, # Optional. Double variant value.
+            "id": "A String", # Required. Variant ID. Max length: 128 bytes.
+            "integerValue": "A String", # Optional. Integer variant value.
+            "stringValue": "A String", # Optional. String variant value.
+            "trackingId": "A String", # Optional. trackingId is unique depending on name and value of the variant within the scope of the service. It is typically generated by the server and must not be changed. trackingId is used to uniquely identify and track variants.
+          },
+        ],
+      },
+      "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.
+    },
+  ],
+  "nextPageToken": "A String", # If present, the next page token can be provided to a subsequent ListFlagRevisions call to list the next page. If empty, there are no more pages.
+  "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, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None) +
Update a single flag revision.
+
+Args:
+  name: string, Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagRevisions/{flag_revision_id}" (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A snapshot of the EvaluationSpec for the Flag.
+  "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",
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "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.
+  "evaluationSpec": { # EvaluationSpec holds rules for evaluating the value of a flag. # Output only. Immutable. Snapshot of the EvaluationSpec for the flag. DEPRECATED: Use snapshot instead.
+    "allocations": [ # Optional. A list of allocations.
+      { # Allocation defines a set of weighted flag variants, specifying how traffic is split based on the randomization unit.
+        "description": "A String", # Optional. Description of the allocation. Max length: 500 bytes.
+        "id": "A String", # Required. Allocation ID. Max length: 128 bytes.
+        "randomizedOn": "A String", # Required. Key of the context attribute that is used for traffic splitting.
+        "slots": [ # Required. Slots defines the weighted distribution of variants.
+          { # AllocationSlot specifies a variant and the proportion of traffic allocated to it.
+            "variant": "A String", # Required. Variant of the allocation slot.
+            "weight": 42, # Required. Weight defines the proportion of traffic to allocate to the variant, relative to other slots in the same allocation.
+          },
+        ],
+      },
+    ],
+    "attributes": [ # Optional. Names of the context attributes that are used in the evaluation rules and allocations.
+      "A String",
+    ],
+    "defaultTarget": "A String", # Required. Default variant or allocation of the flag.
+    "rules": [ # Optional. Evaluation rules define the logic for evaluating the flag against a given context. The rules are evaluated sequentially in their specified order.
+      { # EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user.
+        "condition": "A String", # Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied.
+        "id": "A String", # Required. Evaluation rule ID. Max length: 128 bytes.
+        "target": "A String", # Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.
+      },
+    ],
+    "variants": [ # Optional. A list of variants.
+      { # Variant is an identifier for a value (name assigned to a value). DEPRECATED: Use Flag.Variants instead.
+        "boolValue": True or False, # Optional. Boolean flag value.
+        "doubleValue": 3.14, # Optional. Double flag value.
+        "intValue": "A String", # Optional. Integer flag value.
+        "name": "A String", # Required. Name of the variant. Max length: 128 bytes.
+        "stringValue": "A String", # Optional. String flag value.
+      },
+    ],
+  },
+  "flag": "A String", # Required. Immutable. Name of the Flag this is a revision of.
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagRevisions/{flag_revision_id}"
+  "snapshot": { # Represents a single Flag. # Output only. Immutable. Snapshot of the Flag.
+    "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",
+    },
+    "createTime": "A String", # Output only. The timestamp when the resource was created.
+    "description": "A String", # Optional. Description of the flag. Max length: 500 bytes.
+    "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.
+    "evaluationSpec": { # EvaluationSpec holds rules for evaluating the value of a flag. # Optional. Specification of how the flag value should be evaluated. If a bool flag is created without an evaluation_spec specified, two default variants, "Enabled" (with bool_value = true) and "Disabled" (with bool_value = false), are created by default, and "Disabled" is set as the default_target.
+      "allocations": [ # Optional. A list of allocations.
+        { # Allocation defines a set of weighted flag variants, specifying how traffic is split based on the randomization unit.
+          "description": "A String", # Optional. Description of the allocation. Max length: 500 bytes.
+          "id": "A String", # Required. Allocation ID. Max length: 128 bytes.
+          "randomizedOn": "A String", # Required. Key of the context attribute that is used for traffic splitting.
+          "slots": [ # Required. Slots defines the weighted distribution of variants.
+            { # AllocationSlot specifies a variant and the proportion of traffic allocated to it.
+              "variant": "A String", # Required. Variant of the allocation slot.
+              "weight": 42, # Required. Weight defines the proportion of traffic to allocate to the variant, relative to other slots in the same allocation.
+            },
+          ],
+        },
+      ],
+      "attributes": [ # Optional. Names of the context attributes that are used in the evaluation rules and allocations.
+        "A String",
+      ],
+      "defaultTarget": "A String", # Required. Default variant or allocation of the flag.
+      "rules": [ # Optional. Evaluation rules define the logic for evaluating the flag against a given context. The rules are evaluated sequentially in their specified order.
+        { # EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user.
+          "condition": "A String", # Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied.
+          "id": "A String", # Required. Evaluation rule ID. Max length: 128 bytes.
+          "target": "A String", # Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.
+        },
+      ],
+      "variants": [ # Optional. A list of variants.
+        { # Variant is an identifier for a value (name assigned to a value). DEPRECATED: Use Flag.Variants instead.
+          "boolValue": True or False, # Optional. Boolean flag value.
+          "doubleValue": 3.14, # Optional. Double flag value.
+          "intValue": "A String", # Optional. Integer flag value.
+          "name": "A String", # Required. Name of the variant. Max length: 128 bytes.
+          "stringValue": "A String", # Optional. String flag value.
+        },
+      ],
+    },
+    "flagSet": "A String", # Optional. Flag set this flag belongs to.
+    "flagValueType": "A String", # Optional. Immutable. Flag value type.
+    "key": "A String", # Required. Immutable. Flag key used in runtime evaluation APIs (OpenFeature). Max length: 256 bytes.
+    "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+      "a_key": "A String",
+    },
+    "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flags/{flag_id}"
+    "state": "A String", # Optional. Current state of the flag.
+    "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.
+    "unitKind": "A String", # Required. Immutable. UnitKind that can consume this flag.
+    "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.
+    "valueType": "A String", # Optional. Immutable. Deprecated: Use `flag_value_type` instead. Flag value type.
+    "variants": [ # Optional. A list of variants.
+      { # Variant is an identifier for a value (name assigned to a value).
+        "booleanValue": True or False, # Optional. Boolean variant value.
+        "description": "A String", # Optional. A human-readable description of what this variant does or represents.
+        "doubleValue": 3.14, # Optional. Double variant value.
+        "id": "A String", # Required. Variant ID. Max length: 128 bytes.
+        "integerValue": "A String", # Optional. Integer variant value.
+        "stringValue": "A String", # Optional. String variant value.
+        "trackingId": "A String", # Optional. trackingId is unique depending on name and value of the variant within the scope of the service. It is typically generated by the server and must not be changed. trackingId is used to uniquely identify and track variants.
+      },
+    ],
+  },
+  "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.
+}
+
+  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. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  updateMask: string, Field mask is used to specify the fields to be overwritten in the FlagRevision 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 in the FlagRevision will be overwritten.
+  validateOnly: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A snapshot of the EvaluationSpec for the Flag.
+  "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",
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "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.
+  "evaluationSpec": { # EvaluationSpec holds rules for evaluating the value of a flag. # Output only. Immutable. Snapshot of the EvaluationSpec for the flag. DEPRECATED: Use snapshot instead.
+    "allocations": [ # Optional. A list of allocations.
+      { # Allocation defines a set of weighted flag variants, specifying how traffic is split based on the randomization unit.
+        "description": "A String", # Optional. Description of the allocation. Max length: 500 bytes.
+        "id": "A String", # Required. Allocation ID. Max length: 128 bytes.
+        "randomizedOn": "A String", # Required. Key of the context attribute that is used for traffic splitting.
+        "slots": [ # Required. Slots defines the weighted distribution of variants.
+          { # AllocationSlot specifies a variant and the proportion of traffic allocated to it.
+            "variant": "A String", # Required. Variant of the allocation slot.
+            "weight": 42, # Required. Weight defines the proportion of traffic to allocate to the variant, relative to other slots in the same allocation.
+          },
+        ],
+      },
+    ],
+    "attributes": [ # Optional. Names of the context attributes that are used in the evaluation rules and allocations.
+      "A String",
+    ],
+    "defaultTarget": "A String", # Required. Default variant or allocation of the flag.
+    "rules": [ # Optional. Evaluation rules define the logic for evaluating the flag against a given context. The rules are evaluated sequentially in their specified order.
+      { # EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user.
+        "condition": "A String", # Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied.
+        "id": "A String", # Required. Evaluation rule ID. Max length: 128 bytes.
+        "target": "A String", # Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.
+      },
+    ],
+    "variants": [ # Optional. A list of variants.
+      { # Variant is an identifier for a value (name assigned to a value). DEPRECATED: Use Flag.Variants instead.
+        "boolValue": True or False, # Optional. Boolean flag value.
+        "doubleValue": 3.14, # Optional. Double flag value.
+        "intValue": "A String", # Optional. Integer flag value.
+        "name": "A String", # Required. Name of the variant. Max length: 128 bytes.
+        "stringValue": "A String", # Optional. String flag value.
+      },
+    ],
+  },
+  "flag": "A String", # Required. Immutable. Name of the Flag this is a revision of.
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flagRevisions/{flag_revision_id}"
+  "snapshot": { # Represents a single Flag. # Output only. Immutable. Snapshot of the Flag.
+    "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",
+    },
+    "createTime": "A String", # Output only. The timestamp when the resource was created.
+    "description": "A String", # Optional. Description of the flag. Max length: 500 bytes.
+    "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.
+    "evaluationSpec": { # EvaluationSpec holds rules for evaluating the value of a flag. # Optional. Specification of how the flag value should be evaluated. If a bool flag is created without an evaluation_spec specified, two default variants, "Enabled" (with bool_value = true) and "Disabled" (with bool_value = false), are created by default, and "Disabled" is set as the default_target.
+      "allocations": [ # Optional. A list of allocations.
+        { # Allocation defines a set of weighted flag variants, specifying how traffic is split based on the randomization unit.
+          "description": "A String", # Optional. Description of the allocation. Max length: 500 bytes.
+          "id": "A String", # Required. Allocation ID. Max length: 128 bytes.
+          "randomizedOn": "A String", # Required. Key of the context attribute that is used for traffic splitting.
+          "slots": [ # Required. Slots defines the weighted distribution of variants.
+            { # AllocationSlot specifies a variant and the proportion of traffic allocated to it.
+              "variant": "A String", # Required. Variant of the allocation slot.
+              "weight": 42, # Required. Weight defines the proportion of traffic to allocate to the variant, relative to other slots in the same allocation.
+            },
+          ],
+        },
+      ],
+      "attributes": [ # Optional. Names of the context attributes that are used in the evaluation rules and allocations.
+        "A String",
+      ],
+      "defaultTarget": "A String", # Required. Default variant or allocation of the flag.
+      "rules": [ # Optional. Evaluation rules define the logic for evaluating the flag against a given context. The rules are evaluated sequentially in their specified order.
+        { # EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user.
+          "condition": "A String", # Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied.
+          "id": "A String", # Required. Evaluation rule ID. Max length: 128 bytes.
+          "target": "A String", # Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.
+        },
+      ],
+      "variants": [ # Optional. A list of variants.
+        { # Variant is an identifier for a value (name assigned to a value). DEPRECATED: Use Flag.Variants instead.
+          "boolValue": True or False, # Optional. Boolean flag value.
+          "doubleValue": 3.14, # Optional. Double flag value.
+          "intValue": "A String", # Optional. Integer flag value.
+          "name": "A String", # Required. Name of the variant. Max length: 128 bytes.
+          "stringValue": "A String", # Optional. String flag value.
+        },
+      ],
+    },
+    "flagSet": "A String", # Optional. Flag set this flag belongs to.
+    "flagValueType": "A String", # Optional. Immutable. Flag value type.
+    "key": "A String", # Required. Immutable. Flag key used in runtime evaluation APIs (OpenFeature). Max length: 256 bytes.
+    "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+      "a_key": "A String",
+    },
+    "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flags/{flag_id}"
+    "state": "A String", # Optional. Current state of the flag.
+    "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.
+    "unitKind": "A String", # Required. Immutable. UnitKind that can consume this flag.
+    "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.
+    "valueType": "A String", # Optional. Immutable. Deprecated: Use `flag_value_type` instead. Flag value type.
+    "variants": [ # Optional. A list of variants.
+      { # Variant is an identifier for a value (name assigned to a value).
+        "booleanValue": True or False, # Optional. Boolean variant value.
+        "description": "A String", # Optional. A human-readable description of what this variant does or represents.
+        "doubleValue": 3.14, # Optional. Double variant value.
+        "id": "A String", # Required. Variant ID. Max length: 128 bytes.
+        "integerValue": "A String", # Optional. Integer variant value.
+        "stringValue": "A String", # Optional. String variant value.
+        "trackingId": "A String", # Optional. trackingId is unique depending on name and value of the variant within the scope of the service. It is typically generated by the server and must not be changed. trackingId is used to uniquely identify and track variants.
+      },
+    ],
+  },
+  "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.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.flags.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.flags.html new file mode 100644 index 0000000000..d2a150ada0 --- /dev/null +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.flags.html @@ -0,0 +1,625 @@ + + + +

App Lifecycle Manager API . projects . locations . flags

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Create a new flag.

+

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

+

Delete a single flag.

+

+ get(name, x__xgafv=None)

+

Retrieve a single flag.

+

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

+

Retrieve a collection of flags.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Update a single flag.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, flagId=None, requestId=None, validateOnly=None, x__xgafv=None) +
Create a new flag.
+
+Args:
+  parent: string, Required. The parent of the flag. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a single Flag.
+  "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",
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. Description of the flag. Max length: 500 bytes.
+  "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.
+  "evaluationSpec": { # EvaluationSpec holds rules for evaluating the value of a flag. # Optional. Specification of how the flag value should be evaluated. If a bool flag is created without an evaluation_spec specified, two default variants, "Enabled" (with bool_value = true) and "Disabled" (with bool_value = false), are created by default, and "Disabled" is set as the default_target.
+    "allocations": [ # Optional. A list of allocations.
+      { # Allocation defines a set of weighted flag variants, specifying how traffic is split based on the randomization unit.
+        "description": "A String", # Optional. Description of the allocation. Max length: 500 bytes.
+        "id": "A String", # Required. Allocation ID. Max length: 128 bytes.
+        "randomizedOn": "A String", # Required. Key of the context attribute that is used for traffic splitting.
+        "slots": [ # Required. Slots defines the weighted distribution of variants.
+          { # AllocationSlot specifies a variant and the proportion of traffic allocated to it.
+            "variant": "A String", # Required. Variant of the allocation slot.
+            "weight": 42, # Required. Weight defines the proportion of traffic to allocate to the variant, relative to other slots in the same allocation.
+          },
+        ],
+      },
+    ],
+    "attributes": [ # Optional. Names of the context attributes that are used in the evaluation rules and allocations.
+      "A String",
+    ],
+    "defaultTarget": "A String", # Required. Default variant or allocation of the flag.
+    "rules": [ # Optional. Evaluation rules define the logic for evaluating the flag against a given context. The rules are evaluated sequentially in their specified order.
+      { # EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user.
+        "condition": "A String", # Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied.
+        "id": "A String", # Required. Evaluation rule ID. Max length: 128 bytes.
+        "target": "A String", # Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.
+      },
+    ],
+    "variants": [ # Optional. A list of variants.
+      { # Variant is an identifier for a value (name assigned to a value). DEPRECATED: Use Flag.Variants instead.
+        "boolValue": True or False, # Optional. Boolean flag value.
+        "doubleValue": 3.14, # Optional. Double flag value.
+        "intValue": "A String", # Optional. Integer flag value.
+        "name": "A String", # Required. Name of the variant. Max length: 128 bytes.
+        "stringValue": "A String", # Optional. String flag value.
+      },
+    ],
+  },
+  "flagSet": "A String", # Optional. Flag set this flag belongs to.
+  "flagValueType": "A String", # Optional. Immutable. Flag value type.
+  "key": "A String", # Required. Immutable. Flag key used in runtime evaluation APIs (OpenFeature). Max length: 256 bytes.
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flags/{flag_id}"
+  "state": "A String", # Optional. Current state of the flag.
+  "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.
+  "unitKind": "A String", # Required. Immutable. UnitKind that can consume this flag.
+  "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.
+  "valueType": "A String", # Optional. Immutable. Deprecated: Use `flag_value_type` instead. Flag value type.
+  "variants": [ # Optional. A list of variants.
+    { # Variant is an identifier for a value (name assigned to a value).
+      "booleanValue": True or False, # Optional. Boolean variant value.
+      "description": "A String", # Optional. A human-readable description of what this variant does or represents.
+      "doubleValue": 3.14, # Optional. Double variant value.
+      "id": "A String", # Required. Variant ID. Max length: 128 bytes.
+      "integerValue": "A String", # Optional. Integer variant value.
+      "stringValue": "A String", # Optional. String variant value.
+      "trackingId": "A String", # Optional. trackingId is unique depending on name and value of the variant within the scope of the service. It is typically generated by the server and must not be changed. trackingId is used to uniquely identify and track variants.
+    },
+  ],
+}
+
+  flagId: string, Required. The ID value for the new flag.
+  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. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  validateOnly: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a single Flag.
+  "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",
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. Description of the flag. Max length: 500 bytes.
+  "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.
+  "evaluationSpec": { # EvaluationSpec holds rules for evaluating the value of a flag. # Optional. Specification of how the flag value should be evaluated. If a bool flag is created without an evaluation_spec specified, two default variants, "Enabled" (with bool_value = true) and "Disabled" (with bool_value = false), are created by default, and "Disabled" is set as the default_target.
+    "allocations": [ # Optional. A list of allocations.
+      { # Allocation defines a set of weighted flag variants, specifying how traffic is split based on the randomization unit.
+        "description": "A String", # Optional. Description of the allocation. Max length: 500 bytes.
+        "id": "A String", # Required. Allocation ID. Max length: 128 bytes.
+        "randomizedOn": "A String", # Required. Key of the context attribute that is used for traffic splitting.
+        "slots": [ # Required. Slots defines the weighted distribution of variants.
+          { # AllocationSlot specifies a variant and the proportion of traffic allocated to it.
+            "variant": "A String", # Required. Variant of the allocation slot.
+            "weight": 42, # Required. Weight defines the proportion of traffic to allocate to the variant, relative to other slots in the same allocation.
+          },
+        ],
+      },
+    ],
+    "attributes": [ # Optional. Names of the context attributes that are used in the evaluation rules and allocations.
+      "A String",
+    ],
+    "defaultTarget": "A String", # Required. Default variant or allocation of the flag.
+    "rules": [ # Optional. Evaluation rules define the logic for evaluating the flag against a given context. The rules are evaluated sequentially in their specified order.
+      { # EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user.
+        "condition": "A String", # Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied.
+        "id": "A String", # Required. Evaluation rule ID. Max length: 128 bytes.
+        "target": "A String", # Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.
+      },
+    ],
+    "variants": [ # Optional. A list of variants.
+      { # Variant is an identifier for a value (name assigned to a value). DEPRECATED: Use Flag.Variants instead.
+        "boolValue": True or False, # Optional. Boolean flag value.
+        "doubleValue": 3.14, # Optional. Double flag value.
+        "intValue": "A String", # Optional. Integer flag value.
+        "name": "A String", # Required. Name of the variant. Max length: 128 bytes.
+        "stringValue": "A String", # Optional. String flag value.
+      },
+    ],
+  },
+  "flagSet": "A String", # Optional. Flag set this flag belongs to.
+  "flagValueType": "A String", # Optional. Immutable. Flag value type.
+  "key": "A String", # Required. Immutable. Flag key used in runtime evaluation APIs (OpenFeature). Max length: 256 bytes.
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flags/{flag_id}"
+  "state": "A String", # Optional. Current state of the flag.
+  "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.
+  "unitKind": "A String", # Required. Immutable. UnitKind that can consume this flag.
+  "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.
+  "valueType": "A String", # Optional. Immutable. Deprecated: Use `flag_value_type` instead. Flag value type.
+  "variants": [ # Optional. A list of variants.
+    { # Variant is an identifier for a value (name assigned to a value).
+      "booleanValue": True or False, # Optional. Boolean variant value.
+      "description": "A String", # Optional. A human-readable description of what this variant does or represents.
+      "doubleValue": 3.14, # Optional. Double variant value.
+      "id": "A String", # Required. Variant ID. Max length: 128 bytes.
+      "integerValue": "A String", # Optional. Integer variant value.
+      "stringValue": "A String", # Optional. String variant value.
+      "trackingId": "A String", # Optional. trackingId is unique depending on name and value of the variant within the scope of the service. It is typically generated by the server and must not be changed. trackingId is used to uniquely identify and track variants.
+    },
+  ],
+}
+
+ +
+ delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None) +
Delete a single flag.
+
+Args:
+  name: string, Required. The resource name of the resource within a service. (required)
+  etag: string, The etag known to the client for the expected state of the flag. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the flag. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.
+  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. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  validateOnly: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Retrieve a single flag.
+
+Args:
+  name: string, Required. The resource name of the resource within a service. (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 single Flag.
+  "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",
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. Description of the flag. Max length: 500 bytes.
+  "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.
+  "evaluationSpec": { # EvaluationSpec holds rules for evaluating the value of a flag. # Optional. Specification of how the flag value should be evaluated. If a bool flag is created without an evaluation_spec specified, two default variants, "Enabled" (with bool_value = true) and "Disabled" (with bool_value = false), are created by default, and "Disabled" is set as the default_target.
+    "allocations": [ # Optional. A list of allocations.
+      { # Allocation defines a set of weighted flag variants, specifying how traffic is split based on the randomization unit.
+        "description": "A String", # Optional. Description of the allocation. Max length: 500 bytes.
+        "id": "A String", # Required. Allocation ID. Max length: 128 bytes.
+        "randomizedOn": "A String", # Required. Key of the context attribute that is used for traffic splitting.
+        "slots": [ # Required. Slots defines the weighted distribution of variants.
+          { # AllocationSlot specifies a variant and the proportion of traffic allocated to it.
+            "variant": "A String", # Required. Variant of the allocation slot.
+            "weight": 42, # Required. Weight defines the proportion of traffic to allocate to the variant, relative to other slots in the same allocation.
+          },
+        ],
+      },
+    ],
+    "attributes": [ # Optional. Names of the context attributes that are used in the evaluation rules and allocations.
+      "A String",
+    ],
+    "defaultTarget": "A String", # Required. Default variant or allocation of the flag.
+    "rules": [ # Optional. Evaluation rules define the logic for evaluating the flag against a given context. The rules are evaluated sequentially in their specified order.
+      { # EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user.
+        "condition": "A String", # Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied.
+        "id": "A String", # Required. Evaluation rule ID. Max length: 128 bytes.
+        "target": "A String", # Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.
+      },
+    ],
+    "variants": [ # Optional. A list of variants.
+      { # Variant is an identifier for a value (name assigned to a value). DEPRECATED: Use Flag.Variants instead.
+        "boolValue": True or False, # Optional. Boolean flag value.
+        "doubleValue": 3.14, # Optional. Double flag value.
+        "intValue": "A String", # Optional. Integer flag value.
+        "name": "A String", # Required. Name of the variant. Max length: 128 bytes.
+        "stringValue": "A String", # Optional. String flag value.
+      },
+    ],
+  },
+  "flagSet": "A String", # Optional. Flag set this flag belongs to.
+  "flagValueType": "A String", # Optional. Immutable. Flag value type.
+  "key": "A String", # Required. Immutable. Flag key used in runtime evaluation APIs (OpenFeature). Max length: 256 bytes.
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flags/{flag_id}"
+  "state": "A String", # Optional. Current state of the flag.
+  "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.
+  "unitKind": "A String", # Required. Immutable. UnitKind that can consume this flag.
+  "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.
+  "valueType": "A String", # Optional. Immutable. Deprecated: Use `flag_value_type` instead. Flag value type.
+  "variants": [ # Optional. A list of variants.
+    { # Variant is an identifier for a value (name assigned to a value).
+      "booleanValue": True or False, # Optional. Boolean variant value.
+      "description": "A String", # Optional. A human-readable description of what this variant does or represents.
+      "doubleValue": 3.14, # Optional. Double variant value.
+      "id": "A String", # Required. Variant ID. Max length: 128 bytes.
+      "integerValue": "A String", # Optional. Integer variant value.
+      "stringValue": "A String", # Optional. String variant value.
+      "trackingId": "A String", # Optional. trackingId is unique depending on name and value of the variant within the scope of the service. It is typically generated by the server and must not be changed. trackingId is used to uniquely identify and track variants.
+    },
+  ],
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Retrieve a collection of flags.
+
+Args:
+  parent: string, Required. The parent of the flag. (required)
+  filter: string, Filter the list as specified in https://google.aip.dev/160.
+  orderBy: string, Order results as specified in https://google.aip.dev/132.
+  pageSize: integer, The maximum number of flags to send per page.
+  pageToken: string, The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response structure for the ListFlags method.
+  "flags": [ # The resulting flags.
+    { # Represents a single Flag.
+      "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",
+      },
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "description": "A String", # Optional. Description of the flag. Max length: 500 bytes.
+      "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.
+      "evaluationSpec": { # EvaluationSpec holds rules for evaluating the value of a flag. # Optional. Specification of how the flag value should be evaluated. If a bool flag is created without an evaluation_spec specified, two default variants, "Enabled" (with bool_value = true) and "Disabled" (with bool_value = false), are created by default, and "Disabled" is set as the default_target.
+        "allocations": [ # Optional. A list of allocations.
+          { # Allocation defines a set of weighted flag variants, specifying how traffic is split based on the randomization unit.
+            "description": "A String", # Optional. Description of the allocation. Max length: 500 bytes.
+            "id": "A String", # Required. Allocation ID. Max length: 128 bytes.
+            "randomizedOn": "A String", # Required. Key of the context attribute that is used for traffic splitting.
+            "slots": [ # Required. Slots defines the weighted distribution of variants.
+              { # AllocationSlot specifies a variant and the proportion of traffic allocated to it.
+                "variant": "A String", # Required. Variant of the allocation slot.
+                "weight": 42, # Required. Weight defines the proportion of traffic to allocate to the variant, relative to other slots in the same allocation.
+              },
+            ],
+          },
+        ],
+        "attributes": [ # Optional. Names of the context attributes that are used in the evaluation rules and allocations.
+          "A String",
+        ],
+        "defaultTarget": "A String", # Required. Default variant or allocation of the flag.
+        "rules": [ # Optional. Evaluation rules define the logic for evaluating the flag against a given context. The rules are evaluated sequentially in their specified order.
+          { # EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user.
+            "condition": "A String", # Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied.
+            "id": "A String", # Required. Evaluation rule ID. Max length: 128 bytes.
+            "target": "A String", # Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.
+          },
+        ],
+        "variants": [ # Optional. A list of variants.
+          { # Variant is an identifier for a value (name assigned to a value). DEPRECATED: Use Flag.Variants instead.
+            "boolValue": True or False, # Optional. Boolean flag value.
+            "doubleValue": 3.14, # Optional. Double flag value.
+            "intValue": "A String", # Optional. Integer flag value.
+            "name": "A String", # Required. Name of the variant. Max length: 128 bytes.
+            "stringValue": "A String", # Optional. String flag value.
+          },
+        ],
+      },
+      "flagSet": "A String", # Optional. Flag set this flag belongs to.
+      "flagValueType": "A String", # Optional. Immutable. Flag value type.
+      "key": "A String", # Required. Immutable. Flag key used in runtime evaluation APIs (OpenFeature). Max length: 256 bytes.
+      "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flags/{flag_id}"
+      "state": "A String", # Optional. Current state of the flag.
+      "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.
+      "unitKind": "A String", # Required. Immutable. UnitKind that can consume this flag.
+      "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.
+      "valueType": "A String", # Optional. Immutable. Deprecated: Use `flag_value_type` instead. Flag value type.
+      "variants": [ # Optional. A list of variants.
+        { # Variant is an identifier for a value (name assigned to a value).
+          "booleanValue": True or False, # Optional. Boolean variant value.
+          "description": "A String", # Optional. A human-readable description of what this variant does or represents.
+          "doubleValue": 3.14, # Optional. Double variant value.
+          "id": "A String", # Required. Variant ID. Max length: 128 bytes.
+          "integerValue": "A String", # Optional. Integer variant value.
+          "stringValue": "A String", # Optional. String variant value.
+          "trackingId": "A String", # Optional. trackingId is unique depending on name and value of the variant within the scope of the service. It is typically generated by the server and must not be changed. trackingId is used to uniquely identify and track variants.
+        },
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # If present, the next page token can be provided to a subsequent ListFlags call to list the next page. If empty, there are no more pages.
+  "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, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None) +
Update a single flag.
+
+Args:
+  name: string, Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flags/{flag_id}" (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a single Flag.
+  "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",
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. Description of the flag. Max length: 500 bytes.
+  "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.
+  "evaluationSpec": { # EvaluationSpec holds rules for evaluating the value of a flag. # Optional. Specification of how the flag value should be evaluated. If a bool flag is created without an evaluation_spec specified, two default variants, "Enabled" (with bool_value = true) and "Disabled" (with bool_value = false), are created by default, and "Disabled" is set as the default_target.
+    "allocations": [ # Optional. A list of allocations.
+      { # Allocation defines a set of weighted flag variants, specifying how traffic is split based on the randomization unit.
+        "description": "A String", # Optional. Description of the allocation. Max length: 500 bytes.
+        "id": "A String", # Required. Allocation ID. Max length: 128 bytes.
+        "randomizedOn": "A String", # Required. Key of the context attribute that is used for traffic splitting.
+        "slots": [ # Required. Slots defines the weighted distribution of variants.
+          { # AllocationSlot specifies a variant and the proportion of traffic allocated to it.
+            "variant": "A String", # Required. Variant of the allocation slot.
+            "weight": 42, # Required. Weight defines the proportion of traffic to allocate to the variant, relative to other slots in the same allocation.
+          },
+        ],
+      },
+    ],
+    "attributes": [ # Optional. Names of the context attributes that are used in the evaluation rules and allocations.
+      "A String",
+    ],
+    "defaultTarget": "A String", # Required. Default variant or allocation of the flag.
+    "rules": [ # Optional. Evaluation rules define the logic for evaluating the flag against a given context. The rules are evaluated sequentially in their specified order.
+      { # EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user.
+        "condition": "A String", # Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied.
+        "id": "A String", # Required. Evaluation rule ID. Max length: 128 bytes.
+        "target": "A String", # Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.
+      },
+    ],
+    "variants": [ # Optional. A list of variants.
+      { # Variant is an identifier for a value (name assigned to a value). DEPRECATED: Use Flag.Variants instead.
+        "boolValue": True or False, # Optional. Boolean flag value.
+        "doubleValue": 3.14, # Optional. Double flag value.
+        "intValue": "A String", # Optional. Integer flag value.
+        "name": "A String", # Required. Name of the variant. Max length: 128 bytes.
+        "stringValue": "A String", # Optional. String flag value.
+      },
+    ],
+  },
+  "flagSet": "A String", # Optional. Flag set this flag belongs to.
+  "flagValueType": "A String", # Optional. Immutable. Flag value type.
+  "key": "A String", # Required. Immutable. Flag key used in runtime evaluation APIs (OpenFeature). Max length: 256 bytes.
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flags/{flag_id}"
+  "state": "A String", # Optional. Current state of the flag.
+  "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.
+  "unitKind": "A String", # Required. Immutable. UnitKind that can consume this flag.
+  "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.
+  "valueType": "A String", # Optional. Immutable. Deprecated: Use `flag_value_type` instead. Flag value type.
+  "variants": [ # Optional. A list of variants.
+    { # Variant is an identifier for a value (name assigned to a value).
+      "booleanValue": True or False, # Optional. Boolean variant value.
+      "description": "A String", # Optional. A human-readable description of what this variant does or represents.
+      "doubleValue": 3.14, # Optional. Double variant value.
+      "id": "A String", # Required. Variant ID. Max length: 128 bytes.
+      "integerValue": "A String", # Optional. Integer variant value.
+      "stringValue": "A String", # Optional. String variant value.
+      "trackingId": "A String", # Optional. trackingId is unique depending on name and value of the variant within the scope of the service. It is typically generated by the server and must not be changed. trackingId is used to uniquely identify and track variants.
+    },
+  ],
+}
+
+  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. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  updateMask: string, Field mask is used to specify the fields to be overwritten in the Flag 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 in the Flag will be overwritten.
+  validateOnly: boolean, If "validate_only" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a single Flag.
+  "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",
+  },
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. Description of the flag. Max length: 500 bytes.
+  "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.
+  "evaluationSpec": { # EvaluationSpec holds rules for evaluating the value of a flag. # Optional. Specification of how the flag value should be evaluated. If a bool flag is created without an evaluation_spec specified, two default variants, "Enabled" (with bool_value = true) and "Disabled" (with bool_value = false), are created by default, and "Disabled" is set as the default_target.
+    "allocations": [ # Optional. A list of allocations.
+      { # Allocation defines a set of weighted flag variants, specifying how traffic is split based on the randomization unit.
+        "description": "A String", # Optional. Description of the allocation. Max length: 500 bytes.
+        "id": "A String", # Required. Allocation ID. Max length: 128 bytes.
+        "randomizedOn": "A String", # Required. Key of the context attribute that is used for traffic splitting.
+        "slots": [ # Required. Slots defines the weighted distribution of variants.
+          { # AllocationSlot specifies a variant and the proportion of traffic allocated to it.
+            "variant": "A String", # Required. Variant of the allocation slot.
+            "weight": 42, # Required. Weight defines the proportion of traffic to allocate to the variant, relative to other slots in the same allocation.
+          },
+        ],
+      },
+    ],
+    "attributes": [ # Optional. Names of the context attributes that are used in the evaluation rules and allocations.
+      "A String",
+    ],
+    "defaultTarget": "A String", # Required. Default variant or allocation of the flag.
+    "rules": [ # Optional. Evaluation rules define the logic for evaluating the flag against a given context. The rules are evaluated sequentially in their specified order.
+      { # EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user.
+        "condition": "A String", # Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied.
+        "id": "A String", # Required. Evaluation rule ID. Max length: 128 bytes.
+        "target": "A String", # Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.
+      },
+    ],
+    "variants": [ # Optional. A list of variants.
+      { # Variant is an identifier for a value (name assigned to a value). DEPRECATED: Use Flag.Variants instead.
+        "boolValue": True or False, # Optional. Boolean flag value.
+        "doubleValue": 3.14, # Optional. Double flag value.
+        "intValue": "A String", # Optional. Integer flag value.
+        "name": "A String", # Required. Name of the variant. Max length: 128 bytes.
+        "stringValue": "A String", # Optional. String flag value.
+      },
+    ],
+  },
+  "flagSet": "A String", # Optional. Flag set this flag belongs to.
+  "flagValueType": "A String", # Optional. Immutable. Flag value type.
+  "key": "A String", # Required. Immutable. Flag key used in runtime evaluation APIs (OpenFeature). Max length: 256 bytes.
+  "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/flags/{flag_id}"
+  "state": "A String", # Optional. Current state of the flag.
+  "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.
+  "unitKind": "A String", # Required. Immutable. UnitKind that can consume this flag.
+  "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.
+  "valueType": "A String", # Optional. Immutable. Deprecated: Use `flag_value_type` instead. Flag value type.
+  "variants": [ # Optional. A list of variants.
+    { # Variant is an identifier for a value (name assigned to a value).
+      "booleanValue": True or False, # Optional. Boolean variant value.
+      "description": "A String", # Optional. A human-readable description of what this variant does or represents.
+      "doubleValue": 3.14, # Optional. Double variant value.
+      "id": "A String", # Required. Variant ID. Max length: 128 bytes.
+      "integerValue": "A String", # Optional. Integer variant value.
+      "stringValue": "A String", # Optional. String variant value.
+      "trackingId": "A String", # Optional. trackingId is unique depending on name and value of the variant within the scope of the service. It is typically generated by the server and must not be changed. trackingId is used to uniquely identify and track variants.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.html index 2b3cd501d9..3f5bc95412 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.html @@ -72,8 +72,28 @@ -

SaaS Runtime API . projects . locations

+

App Lifecycle Manager API . projects . locations

Instance Methods

+

+ flagAttributes() +

+

Returns the flagAttributes Resource.

+ +

+ flagReleases() +

+

Returns the flagReleases Resource.

+ +

+ flagRevisions() +

+

Returns the flagRevisions Resource.

+ +

+ flags() +

+

Returns the flags Resource.

+

releases()

diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.releases.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.releases.html index 602a8a369b..d77b64272a 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.releases.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.releases.html @@ -72,7 +72,7 @@ -

SaaS Runtime API . projects . locations . releases

+

App Lifecycle Manager API . projects . locations . releases

Instance Methods

close()

diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.rolloutKinds.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.rolloutKinds.html index dc571f00fc..0b527af320 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.rolloutKinds.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.rolloutKinds.html @@ -72,7 +72,7 @@ -

SaaS Runtime API . projects . locations . rolloutKinds

+

App Lifecycle Manager API . projects . locations . rolloutKinds

Instance Methods

close()

diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.rollouts.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.rollouts.html index a81c69984d..6bfdfee456 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.rollouts.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.rollouts.html @@ -72,7 +72,7 @@ -

SaaS Runtime API . projects . locations . rollouts

+

App Lifecycle Manager API . projects . locations . rollouts

Instance Methods

close()

@@ -125,6 +125,7 @@

Method Details

"effectiveUnitFilter": "A String", # Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind.unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here. "endTime": "A String", # Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final. "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. + "flagRelease": "A String", # Optional. Immutable. Name of the FlagRelease to be rolled out to the target Units. Release and FlagRelease are mutually exclusive. Note: `release` comment needs to be adjusted to mention that "Release and FlagRelease are mutually exclusive" when visibility restriction will be lifted. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, @@ -178,6 +179,7 @@

Method Details

"effectiveUnitFilter": "A String", # Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind.unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here. "endTime": "A String", # Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final. "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. + "flagRelease": "A String", # Optional. Immutable. Name of the FlagRelease to be rolled out to the target Units. Release and FlagRelease are mutually exclusive. Note: `release` comment needs to be adjusted to mention that "Release and FlagRelease are mutually exclusive" when visibility restriction will be lifted. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, @@ -256,6 +258,7 @@

Method Details

"effectiveUnitFilter": "A String", # Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind.unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here. "endTime": "A String", # Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final. "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. + "flagRelease": "A String", # Optional. Immutable. Name of the FlagRelease to be rolled out to the target Units. Release and FlagRelease are mutually exclusive. Note: `release` comment needs to be adjusted to mention that "Release and FlagRelease are mutually exclusive" when visibility restriction will be lifted. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, @@ -320,6 +323,7 @@

Method Details

"effectiveUnitFilter": "A String", # Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind.unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here. "endTime": "A String", # Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final. "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. + "flagRelease": "A String", # Optional. Immutable. Name of the FlagRelease to be rolled out to the target Units. Release and FlagRelease are mutually exclusive. Note: `release` comment needs to be adjusted to mention that "Release and FlagRelease are mutually exclusive" when visibility restriction will be lifted. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, @@ -391,6 +395,7 @@

Method Details

"effectiveUnitFilter": "A String", # Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind.unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here. "endTime": "A String", # Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final. "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. + "flagRelease": "A String", # Optional. Immutable. Name of the FlagRelease to be rolled out to the target Units. Release and FlagRelease are mutually exclusive. Note: `release` comment needs to be adjusted to mention that "Release and FlagRelease are mutually exclusive" when visibility restriction will be lifted. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, @@ -444,6 +449,7 @@

Method Details

"effectiveUnitFilter": "A String", # Optional. Output only. Output only snapshot of the effective unit filter at Rollout start time. Contains a CEL(https://github.com/google/cel-spec) expression consisting of a conjunction of Rollout.unit_filter and RolloutKind.unit_filter. This field captures the filter applied by the Rollout to determine the Unit population. If the associated RolloutKind's unit_filter is modified after the rollout is started, it will not be updated here. "endTime": "A String", # Optional. Output only. The time when the rollout finished execution (regardless of success, failure, or cancellation). Will be empty if the rollout hasn't finished yet. Once set, the rollout is in terminal state and all the results are final. "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. + "flagRelease": "A String", # Optional. Immutable. Name of the FlagRelease to be rolled out to the target Units. Release and FlagRelease are mutually exclusive. Note: `release` comment needs to be adjusted to mention that "Release and FlagRelease are mutually exclusive" when visibility restriction will be lifted. "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.saas.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.saas.html index b9539a4bc9..a42b0513ce 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.saas.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.saas.html @@ -72,7 +72,7 @@ -

SaaS Runtime API . projects . locations . saas

+

App Lifecycle Manager API . projects . locations . saas

Instance Methods

close()

diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.tenants.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.tenants.html index 1f6b6ba1af..9a3ad454e6 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.tenants.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.tenants.html @@ -72,7 +72,7 @@ -

SaaS Runtime API . projects . locations . tenants

+

App Lifecycle Manager API . projects . locations . tenants

Instance Methods

close()

@@ -114,14 +114,14 @@

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", }, - "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by SaaS Runtime for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). + "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by App Lifecycle Manager for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). "createTime": "A String", # Output only. The timestamp when the resource was created. "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", }, "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/tenants/{tenant}" - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. "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. } @@ -141,14 +141,14 @@

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", }, - "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by SaaS Runtime for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). + "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by App Lifecycle Manager for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). "createTime": "A String", # Output only. The timestamp when the resource was created. "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", }, "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/tenants/{tenant}" - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. "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. }
@@ -193,14 +193,14 @@

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", }, - "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by SaaS Runtime for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). + "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by App Lifecycle Manager for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). "createTime": "A String", # Output only. The timestamp when the resource was created. "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", }, "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/tenants/{tenant}" - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. "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. }
@@ -231,14 +231,14 @@

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", }, - "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by SaaS Runtime for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). + "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by App Lifecycle Manager for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). "createTime": "A String", # Output only. The timestamp when the resource was created. "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", }, "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/tenants/{tenant}" - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. "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. }, @@ -276,14 +276,14 @@

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", }, - "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by SaaS Runtime for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). + "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by App Lifecycle Manager for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). "createTime": "A String", # Output only. The timestamp when the resource was created. "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", }, "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/tenants/{tenant}" - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. "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. } @@ -303,14 +303,14 @@

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", }, - "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by SaaS Runtime for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). + "consumerResource": "A String", # Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by App Lifecycle Manager for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API). "createTime": "A String", # Output only. The timestamp when the resource was created. "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", }, "name": "A String", # Identifier. The resource name (full URI of the resource) following the standard naming scheme: "projects/{project}/locations/{location}/tenants/{tenant}" - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. "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 390512d3d9..68458ad102 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.unitKinds.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.unitKinds.html @@ -72,7 +72,7 @@ -

SaaS Runtime API . projects . locations . unitKinds

+

App Lifecycle Manager API . projects . locations . unitKinds

Instance Methods

close()

@@ -116,7 +116,7 @@

Method Details

}, "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. + "scope": { # Scope of an application. # Corresponds to the scope in the ADC composite ApplicationTemplate. Defaults to TYPE_REGIONAL. "type": "A String", # Required. Scope Type. }, }, @@ -130,6 +130,9 @@

Method Details

"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. + "defaultFlagRevisions": [ # Optional. Default revisions of flags for this UnitKind. Newly created units will use the flag default_flag_revisions present at the time of creation. + "A String", + ], "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. { # Dependency represent a single dependency with another unit kind by alias. @@ -146,7 +149,7 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable @@ -164,13 +167,13 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable }, ], - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. Immutable once set. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. Immutable once set. "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. } @@ -192,7 +195,7 @@

Method Details

}, "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. + "scope": { # Scope of an application. # Corresponds to the scope in the ADC composite ApplicationTemplate. Defaults to TYPE_REGIONAL. "type": "A String", # Required. Scope Type. }, }, @@ -206,6 +209,9 @@

Method Details

"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. + "defaultFlagRevisions": [ # Optional. Default revisions of flags for this UnitKind. Newly created units will use the flag default_flag_revisions present at the time of creation. + "A String", + ], "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. { # Dependency represent a single dependency with another unit kind by alias. @@ -222,7 +228,7 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable @@ -240,13 +246,13 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable }, ], - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. Immutable once set. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. Immutable once set. "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. }
@@ -293,7 +299,7 @@

Method Details

}, "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. + "scope": { # Scope of an application. # Corresponds to the scope in the ADC composite ApplicationTemplate. Defaults to TYPE_REGIONAL. "type": "A String", # Required. Scope Type. }, }, @@ -307,6 +313,9 @@

Method Details

"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. + "defaultFlagRevisions": [ # Optional. Default revisions of flags for this UnitKind. Newly created units will use the flag default_flag_revisions present at the time of creation. + "A String", + ], "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. { # Dependency represent a single dependency with another unit kind by alias. @@ -323,7 +332,7 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable @@ -341,13 +350,13 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable }, ], - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. Immutable once set. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. Immutable once set. "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. }
@@ -380,7 +389,7 @@

Method Details

}, "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. + "scope": { # Scope of an application. # Corresponds to the scope in the ADC composite ApplicationTemplate. Defaults to TYPE_REGIONAL. "type": "A String", # Required. Scope Type. }, }, @@ -394,6 +403,9 @@

Method Details

"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. + "defaultFlagRevisions": [ # Optional. Default revisions of flags for this UnitKind. Newly created units will use the flag default_flag_revisions present at the time of creation. + "A String", + ], "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. { # Dependency represent a single dependency with another unit kind by alias. @@ -410,7 +422,7 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable @@ -428,13 +440,13 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable }, ], - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. Immutable once set. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. Immutable once set. "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. }, @@ -474,7 +486,7 @@

Method Details

}, "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. + "scope": { # Scope of an application. # Corresponds to the scope in the ADC composite ApplicationTemplate. Defaults to TYPE_REGIONAL. "type": "A String", # Required. Scope Type. }, }, @@ -488,6 +500,9 @@

Method Details

"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. + "defaultFlagRevisions": [ # Optional. Default revisions of flags for this UnitKind. Newly created units will use the flag default_flag_revisions present at the time of creation. + "A String", + ], "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. { # Dependency represent a single dependency with another unit kind by alias. @@ -504,7 +519,7 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable @@ -522,13 +537,13 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable }, ], - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. Immutable once set. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. Immutable once set. "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. } @@ -550,7 +565,7 @@

Method Details

}, "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. + "scope": { # Scope of an application. # Corresponds to the scope in the ADC composite ApplicationTemplate. Defaults to TYPE_REGIONAL. "type": "A String", # Required. Scope Type. }, }, @@ -564,6 +579,9 @@

Method Details

"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. + "defaultFlagRevisions": [ # Optional. Default revisions of flags for this UnitKind. Newly created units will use the flag default_flag_revisions present at the time of creation. + "A String", + ], "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. { # Dependency represent a single dependency with another unit kind by alias. @@ -580,7 +598,7 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable @@ -598,13 +616,13 @@

Method Details

}, "to": { # Input variables whose values will be passed on to dependencies # Optional. Input variables whose values will be passed on to dependencies. "dependency": "A String", # Required. Alias of the dependency that the inputVariable will pass its value to - "ignoreForLookup": True or False, # Optional. Tells SaaS Runtime if this mapping should be used during lookup or not + "ignoreForLookup": True or False, # Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not "inputVariable": "A String", # Required. Name of the inputVariable on the dependency }, "variable": "A String", # Required. name of the variable }, ], - "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. Immutable once set. + "saas": "A String", # Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. Immutable once set. "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.unitOperations.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.unitOperations.html index 763acf05cd..3a1722e166 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.unitOperations.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.unitOperations.html @@ -72,7 +72,7 @@ -

SaaS Runtime API . projects . locations . unitOperations

+

App Lifecycle Manager API . projects . locations . unitOperations

Instance Methods

close()

@@ -131,6 +131,9 @@

Method Details

"engineState": "A String", # Optional. Output only. The engine state for on-going deployment engine operation(s). This field is opaque for external usage. "errorCategory": "A String", # Optional. Output only. UnitOperationErrorCategory describe the error category. "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. + "flagUpdate": { # FlagUpdate is a UnitOperation that pushes new flag values to Units. + "flagRelease": "A String", # Required. Flag release being applied by UnitOperation. + }, "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, @@ -198,6 +201,9 @@

Method Details

"engineState": "A String", # Optional. Output only. The engine state for on-going deployment engine operation(s). This field is opaque for external usage. "errorCategory": "A String", # Optional. Output only. UnitOperationErrorCategory describe the error category. "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. + "flagUpdate": { # FlagUpdate is a UnitOperation that pushes new flag values to Units. + "flagRelease": "A String", # Required. Flag release being applied by UnitOperation. + }, "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, @@ -290,6 +296,9 @@

Method Details

"engineState": "A String", # Optional. Output only. The engine state for on-going deployment engine operation(s). This field is opaque for external usage. "errorCategory": "A String", # Optional. Output only. UnitOperationErrorCategory describe the error category. "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. + "flagUpdate": { # FlagUpdate is a UnitOperation that pushes new flag values to Units. + "flagRelease": "A String", # Required. Flag release being applied by UnitOperation. + }, "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, @@ -368,6 +377,9 @@

Method Details

"engineState": "A String", # Optional. Output only. The engine state for on-going deployment engine operation(s). This field is opaque for external usage. "errorCategory": "A String", # Optional. Output only. UnitOperationErrorCategory describe the error category. "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. + "flagUpdate": { # FlagUpdate is a UnitOperation that pushes new flag values to Units. + "flagRelease": "A String", # Required. Flag release being applied by UnitOperation. + }, "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, @@ -453,6 +465,9 @@

Method Details

"engineState": "A String", # Optional. Output only. The engine state for on-going deployment engine operation(s). This field is opaque for external usage. "errorCategory": "A String", # Optional. Output only. UnitOperationErrorCategory describe the error category. "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. + "flagUpdate": { # FlagUpdate is a UnitOperation that pushes new flag values to Units. + "flagRelease": "A String", # Required. Flag release being applied by UnitOperation. + }, "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, @@ -520,6 +535,9 @@

Method Details

"engineState": "A String", # Optional. Output only. The engine state for on-going deployment engine operation(s). This field is opaque for external usage. "errorCategory": "A String", # Optional. Output only. UnitOperationErrorCategory describe the error category. "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. + "flagUpdate": { # FlagUpdate is a UnitOperation that pushes new flag values to Units. + "flagRelease": "A String", # Required. Flag release being applied by UnitOperation. + }, "labels": { # Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels. "a_key": "A String", }, diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.units.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.units.html index 6517328f00..a1558956aa 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.units.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.units.html @@ -72,7 +72,7 @@ -

SaaS Runtime API . projects . locations . units

+

App Lifecycle Manager API . projects . locations . units

Instance Methods

close()

@@ -138,6 +138,10 @@

Method Details

}, ], "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. + "flagConfigName": "A String", # Output only. This field stores the unique identifier for the flag configuration to be used by this Unit. + "flagRevisions": [ # Optional. Output only. Flag revisions used by this Unit. + "A String", + ], "inputVariables": [ # Optional. Output only. Indicates the current input variables deployed by the unit { # UnitVariable describes a parameter for a Unit. "type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool. @@ -220,6 +224,10 @@

Method Details

}, ], "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. + "flagConfigName": "A String", # Output only. This field stores the unique identifier for the flag configuration to be used by this Unit. + "flagRevisions": [ # Optional. Output only. Flag revisions used by this Unit. + "A String", + ], "inputVariables": [ # Optional. Output only. Indicates the current input variables deployed by the unit { # UnitVariable describes a parameter for a Unit. "type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool. @@ -327,6 +335,10 @@

Method Details

}, ], "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. + "flagConfigName": "A String", # Output only. This field stores the unique identifier for the flag configuration to be used by this Unit. + "flagRevisions": [ # Optional. Output only. Flag revisions used by this Unit. + "A String", + ], "inputVariables": [ # Optional. Output only. Indicates the current input variables deployed by the unit { # UnitVariable describes a parameter for a Unit. "type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool. @@ -420,6 +432,10 @@

Method Details

}, ], "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. + "flagConfigName": "A String", # Output only. This field stores the unique identifier for the flag configuration to be used by this Unit. + "flagRevisions": [ # Optional. Output only. Flag revisions used by this Unit. + "A String", + ], "inputVariables": [ # Optional. Output only. Indicates the current input variables deployed by the unit { # UnitVariable describes a parameter for a Unit. "type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool. @@ -520,6 +536,10 @@

Method Details

}, ], "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. + "flagConfigName": "A String", # Output only. This field stores the unique identifier for the flag configuration to be used by this Unit. + "flagRevisions": [ # Optional. Output only. Flag revisions used by this Unit. + "A String", + ], "inputVariables": [ # Optional. Output only. Indicates the current input variables deployed by the unit { # UnitVariable describes a parameter for a Unit. "type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool. @@ -602,6 +622,10 @@

Method Details

}, ], "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. + "flagConfigName": "A String", # Output only. This field stores the unique identifier for the flag configuration to be used by this Unit. + "flagRevisions": [ # Optional. Output only. Flag revisions used by this Unit. + "A String", + ], "inputVariables": [ # Optional. Output only. Indicates the current input variables deployed by the unit { # UnitVariable describes a parameter for a Unit. "type": "A String", # Optional. Immutable. Name of a supported variable type. Supported types are string, int, bool. diff --git a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1.json b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1.json index 1dd14a3aac..22688b15cc 100644 --- a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1.json +++ b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1.json @@ -1804,7 +1804,7 @@ } } }, -"revision": "20260325", +"revision": "20260407", "rootUrl": "https://saasservicemgmt.googleapis.com/", "schemas": { "Aggregate": { @@ -1888,6 +1888,17 @@ }, "type": "object" }, +"FlagUpdate": { +"description": "FlagUpdate is a UnitOperation that pushes new flag values to Units.", +"id": "FlagUpdate", +"properties": { +"flagRelease": { +"description": "Required. Flag release being applied by UnitOperation.", +"type": "string" +} +}, +"type": "object" +}, "FromMapping": { "description": "Output variables whose values will be passed on to dependencies", "id": "FromMapping", @@ -2335,6 +2346,10 @@ "readOnly": true, "type": "string" }, +"flagRelease": { +"description": "Optional. Immutable. Name of the FlagRelease to be rolled out to the target Units. Release and FlagRelease are mutually exclusive. Note: `release` comment needs to be adjusted to mention that \"Release and FlagRelease are mutually exclusive\" when visibility restriction will be lifted.", +"type": "string" +}, "labels": { "additionalProperties": { "type": "string" @@ -2630,30 +2645,30 @@ "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" +"STATE_FAILED", +"ACTIVE", +"RUNNING", +"FAILED" ], "enumDeprecated": [ false, -true, -true, -true, false, false, -false +false, +true, +true, +true ], "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" +"Failure during process of importing, synchronizing or replicating ApplicationTemplate processing", +"Deprecated: Use STATE_ACTIVE.", +"Deprecated: Use STATE_RUNNING.", +"Deprecated: Use STATE_FAILED." ], "readOnly": true, "type": "string" @@ -2773,7 +2788,7 @@ false "type": "object" }, "consumerResource": { -"description": "Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by SaaS Runtime for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API).", +"description": "Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by App Lifecycle Manager for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API).", "type": "string" }, "createTime": { @@ -2799,7 +2814,7 @@ false "type": "string" }, "saas": { -"description": "Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model.", +"description": "Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model.", "type": "string" }, "uid": { @@ -2825,7 +2840,7 @@ false "type": "string" }, "ignoreForLookup": { -"description": "Optional. Tells SaaS Runtime if this mapping should be used during lookup or not", +"description": "Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not", "type": "boolean" }, "inputVariable": { @@ -2881,6 +2896,14 @@ false "readOnly": true, "type": "string" }, +"flagRevisions": { +"description": "Optional. Output only. Flag revisions used by this Unit.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "inputVariables": { "description": "Optional. Output only. Indicates the current input variables deployed by the unit", "items": { @@ -3121,6 +3144,13 @@ false "readOnly": true, "type": "string" }, +"defaultFlagRevisions": { +"description": "Optional. Default revisions of flags for this UnitKind. Newly created units will use the flag default_flag_revisions present at the time of creation.", +"items": { +"type": "string" +}, +"type": "array" +}, "defaultRelease": { "description": "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.", "type": "string" @@ -3163,7 +3193,7 @@ false "type": "array" }, "saas": { -"description": "Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. Immutable once set.", +"description": "Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. Immutable once set.", "type": "string" }, "uid": { @@ -3249,6 +3279,9 @@ false "readOnly": true, "type": "string" }, +"flagUpdate": { +"$ref": "FlagUpdate" +}, "labels": { "additionalProperties": { "type": "string" @@ -3387,13 +3420,17 @@ false "TYPE_UNSPECIFIED", "STRING", "INT", -"BOOL" +"BOOL", +"STRUCT", +"LIST" ], "enumDescriptions": [ "Variable type is unspecified.", "Variable type is string.", "Variable type is int.", -"Variable type is bool." +"Variable type is bool.", +"Variable type is struct.", +"Variable type is list." ], "type": "string" }, @@ -3447,7 +3484,7 @@ false } }, "servicePath": "", -"title": "SaaS Runtime API", +"title": "App Lifecycle Manager API", "version": "v1", "version_module": true } \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json index b78fbc28a2..bb609a968a 100644 --- a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json @@ -183,29 +183,29 @@ } }, "resources": { -"releases": { +"flagAttributes": { "methods": { "create": { -"description": "Create a new release.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/releases", +"description": "Create a new flag attribute.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/flagAttributes", "httpMethod": "POST", -"id": "saasservicemgmt.projects.locations.releases.create", +"id": "saasservicemgmt.projects.locations.flagAttributes.create", "parameterOrder": [ "parent" ], "parameters": { +"flagAttributeId": { +"description": "Required. The ID value for the new flag attribute.", +"location": "query", +"type": "string" +}, "parent": { -"description": "Required. The parent of the release.", +"description": "Required. The parent of the flag attribute.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, -"releaseId": { -"description": "Required. The ID value for the new release.", -"location": "query", -"type": "string" -}, "requestId": { "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", @@ -217,35 +217,35 @@ "type": "boolean" } }, -"path": "v1beta1/{+parent}/releases", +"path": "v1beta1/{+parent}/flagAttributes", "request": { -"$ref": "Release" +"$ref": "FlagAttribute" }, "response": { -"$ref": "Release" +"$ref": "FlagAttribute" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Delete a single release.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/releases/{releasesId}", +"description": "Delete a single flag attribute.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/flagAttributes/{flagAttributesId}", "httpMethod": "DELETE", -"id": "saasservicemgmt.projects.locations.releases.delete", +"id": "saasservicemgmt.projects.locations.flagAttributes.delete", "parameterOrder": [ "name" ], "parameters": { "etag": { -"description": "The etag known to the client for the expected state of the release. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the release. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", +"description": "The etag known to the client for the expected state of the flag attribute. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the flag attribute. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", "location": "query", "type": "string" }, "name": { "description": "Required. The resource name of the resource within a service.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/releases/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/flagAttributes/[^/]+$", "required": true, "type": "string" }, @@ -269,10 +269,10 @@ ] }, "get": { -"description": "Retrieve a single release.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/releases/{releasesId}", +"description": "Retrieve a single flag attribute.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/flagAttributes/{flagAttributesId}", "httpMethod": "GET", -"id": "saasservicemgmt.projects.locations.releases.get", +"id": "saasservicemgmt.projects.locations.flagAttributes.get", "parameterOrder": [ "name" ], @@ -280,24 +280,24 @@ "name": { "description": "Required. The resource name of the resource within a service.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/releases/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/flagAttributes/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "Release" +"$ref": "FlagAttribute" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Retrieve a collection of releases.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/releases", +"description": "Retrieve a collection of flag attributes.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/flagAttributes", "httpMethod": "GET", -"id": "saasservicemgmt.projects.locations.releases.list", +"id": "saasservicemgmt.projects.locations.flagAttributes.list", "parameterOrder": [ "parent" ], @@ -313,7 +313,7 @@ "type": "string" }, "pageSize": { -"description": "The maximum number of releases to send per page.", +"description": "The maximum number of flag attributes to send per page.", "format": "int32", "location": "query", "type": "integer" @@ -324,34 +324,34 @@ "type": "string" }, "parent": { -"description": "Required. The parent of the release.", +"description": "Required. The parent of the flag attribute.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/releases", +"path": "v1beta1/{+parent}/flagAttributes", "response": { -"$ref": "ListReleasesResponse" +"$ref": "ListFlagAttributesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { -"description": "Update a single release.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/releases/{releasesId}", +"description": "Update a single flag attribute.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/flagAttributes/{flagAttributesId}", "httpMethod": "PATCH", -"id": "saasservicemgmt.projects.locations.releases.patch", +"id": "saasservicemgmt.projects.locations.flagAttributes.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/releases/{release}\"", +"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/flagAttributes/{flag_attribute_id}\"", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/releases/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/flagAttributes/[^/]+$", "required": true, "type": "string" }, @@ -361,7 +361,7 @@ "type": "string" }, "updateMask": { -"description": "Field mask is used to specify the fields to be overwritten in the Release 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 in the Release will be overwritten.", +"description": "Field mask is used to specify the fields to be overwritten in the FlagAttribute 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 in the FlagAttribute will be overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -374,10 +374,10 @@ }, "path": "v1beta1/{+name}", "request": { -"$ref": "Release" +"$ref": "FlagAttribute" }, "response": { -"$ref": "Release" +"$ref": "FlagAttribute" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -385,19 +385,24 @@ } } }, -"rolloutKinds": { +"flagReleases": { "methods": { "create": { -"description": "Create a new rollout kind.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/rolloutKinds", +"description": "Create a new flag release.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/flagReleases", "httpMethod": "POST", -"id": "saasservicemgmt.projects.locations.rolloutKinds.create", +"id": "saasservicemgmt.projects.locations.flagReleases.create", "parameterOrder": [ "parent" ], "parameters": { +"flagReleaseId": { +"description": "Required. The ID value for the new flag release.", +"location": "query", +"type": "string" +}, "parent": { -"description": "Required. The parent of the rollout kind.", +"description": "Required. The parent of the flag release.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -408,46 +413,41 @@ "location": "query", "type": "string" }, -"rolloutKindId": { -"description": "Required. The ID value for the new rollout kind.", -"location": "query", -"type": "string" -}, "validateOnly": { "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "location": "query", "type": "boolean" } }, -"path": "v1beta1/{+parent}/rolloutKinds", +"path": "v1beta1/{+parent}/flagReleases", "request": { -"$ref": "RolloutKind" +"$ref": "FlagRelease" }, "response": { -"$ref": "RolloutKind" +"$ref": "FlagRelease" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Delete a single rollout kind.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/rolloutKinds/{rolloutKindsId}", +"description": "Delete a single flag release.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/flagReleases/{flagReleasesId}", "httpMethod": "DELETE", -"id": "saasservicemgmt.projects.locations.rolloutKinds.delete", +"id": "saasservicemgmt.projects.locations.flagReleases.delete", "parameterOrder": [ "name" ], "parameters": { "etag": { -"description": "The etag known to the client for the expected state of the rollout kind. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the rollout kind. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", +"description": "The etag known to the client for the expected state of the flag release. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the flag release. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", "location": "query", "type": "string" }, "name": { "description": "Required. The resource name of the resource within a service.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/rolloutKinds/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/flagReleases/[^/]+$", "required": true, "type": "string" }, @@ -471,10 +471,10 @@ ] }, "get": { -"description": "Retrieve a single rollout kind.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/rolloutKinds/{rolloutKindsId}", +"description": "Retrieve a single flag release.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/flagReleases/{flagReleasesId}", "httpMethod": "GET", -"id": "saasservicemgmt.projects.locations.rolloutKinds.get", +"id": "saasservicemgmt.projects.locations.flagReleases.get", "parameterOrder": [ "name" ], @@ -482,24 +482,24 @@ "name": { "description": "Required. The resource name of the resource within a service.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/rolloutKinds/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/flagReleases/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "RolloutKind" +"$ref": "FlagRelease" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Retrieve a collection of rollout kinds.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/rolloutKinds", +"description": "Retrieve a collection of flag releases.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/flagReleases", "httpMethod": "GET", -"id": "saasservicemgmt.projects.locations.rolloutKinds.list", +"id": "saasservicemgmt.projects.locations.flagReleases.list", "parameterOrder": [ "parent" ], @@ -515,7 +515,7 @@ "type": "string" }, "pageSize": { -"description": "The maximum number of rollout kinds to send per page.", +"description": "The maximum number of flag releases to send per page.", "format": "int32", "location": "query", "type": "integer" @@ -526,34 +526,34 @@ "type": "string" }, "parent": { -"description": "Required. The parent of the rollout kind.", +"description": "Required. The parent of the flag release.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/rolloutKinds", +"path": "v1beta1/{+parent}/flagReleases", "response": { -"$ref": "ListRolloutKindsResponse" +"$ref": "ListFlagReleasesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { -"description": "Update a single rollout kind.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/rolloutKinds/{rolloutKindsId}", +"description": "Update a single flag release.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/flagReleases/{flagReleasesId}", "httpMethod": "PATCH", -"id": "saasservicemgmt.projects.locations.rolloutKinds.patch", +"id": "saasservicemgmt.projects.locations.flagReleases.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}\"", +"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/flagReleases/{flag_release_id}\"", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/rolloutKinds/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/flagReleases/[^/]+$", "required": true, "type": "string" }, @@ -563,7 +563,7 @@ "type": "string" }, "updateMask": { -"description": "Field mask is used to specify the fields to be overwritten in the RolloutKind 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 in the RolloutKind will be overwritten.", +"description": "Field mask is used to specify the fields to be overwritten in the FlagRelease 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 in the FlagRelease will be overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -576,10 +576,10 @@ }, "path": "v1beta1/{+name}", "request": { -"$ref": "RolloutKind" +"$ref": "FlagRelease" }, "response": { -"$ref": "RolloutKind" +"$ref": "FlagRelease" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -587,19 +587,24 @@ } } }, -"rollouts": { +"flagRevisions": { "methods": { "create": { -"description": "Create a new rollout.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/rollouts", +"description": "Create a new flag revision.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/flagRevisions", "httpMethod": "POST", -"id": "saasservicemgmt.projects.locations.rollouts.create", +"id": "saasservicemgmt.projects.locations.flagRevisions.create", "parameterOrder": [ "parent" ], "parameters": { +"flagRevisionId": { +"description": "Required. The ID value for the new flag revision.", +"location": "query", +"type": "string" +}, "parent": { -"description": "Required. The parent of the rollout.", +"description": "Required. The parent of the flag revision.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -610,46 +615,41 @@ "location": "query", "type": "string" }, -"rolloutId": { -"description": "Required. The ID value for the new rollout.", -"location": "query", -"type": "string" -}, "validateOnly": { "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "location": "query", "type": "boolean" } }, -"path": "v1beta1/{+parent}/rollouts", +"path": "v1beta1/{+parent}/flagRevisions", "request": { -"$ref": "Rollout" +"$ref": "FlagRevision" }, "response": { -"$ref": "Rollout" +"$ref": "FlagRevision" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Delete a single rollout.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/rollouts/{rolloutsId}", +"description": "Delete a single flag revision.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/flagRevisions/{flagRevisionsId}", "httpMethod": "DELETE", -"id": "saasservicemgmt.projects.locations.rollouts.delete", +"id": "saasservicemgmt.projects.locations.flagRevisions.delete", "parameterOrder": [ "name" ], "parameters": { "etag": { -"description": "The etag known to the client for the expected state of the rollout. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the rollout. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", +"description": "The etag known to the client for the expected state of the flag revision. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the flag revision. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", "location": "query", "type": "string" }, "name": { "description": "Required. The resource name of the resource within a service.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/rollouts/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/flagRevisions/[^/]+$", "required": true, "type": "string" }, @@ -673,10 +673,10 @@ ] }, "get": { -"description": "Retrieve a single rollout.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/rollouts/{rolloutsId}", +"description": "Retrieve a single flag revision.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/flagRevisions/{flagRevisionsId}", "httpMethod": "GET", -"id": "saasservicemgmt.projects.locations.rollouts.get", +"id": "saasservicemgmt.projects.locations.flagRevisions.get", "parameterOrder": [ "name" ], @@ -684,24 +684,24 @@ "name": { "description": "Required. The resource name of the resource within a service.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/rollouts/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/flagRevisions/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "Rollout" +"$ref": "FlagRevision" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Retrieve a collection of rollouts.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/rollouts", +"description": "Retrieve a collection of flag revisions.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/flagRevisions", "httpMethod": "GET", -"id": "saasservicemgmt.projects.locations.rollouts.list", +"id": "saasservicemgmt.projects.locations.flagRevisions.list", "parameterOrder": [ "parent" ], @@ -717,7 +717,7 @@ "type": "string" }, "pageSize": { -"description": "The maximum number of rollouts to send per page.", +"description": "The maximum number of flag revisions to send per page.", "format": "int32", "location": "query", "type": "integer" @@ -728,34 +728,34 @@ "type": "string" }, "parent": { -"description": "Required. The parent of the rollout.", +"description": "Required. The parent of the flag revision.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/rollouts", +"path": "v1beta1/{+parent}/flagRevisions", "response": { -"$ref": "ListRolloutsResponse" +"$ref": "ListFlagRevisionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { -"description": "Update a single rollout.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/rollouts/{rolloutsId}", +"description": "Update a single flag revision.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/flagRevisions/{flagRevisionsId}", "httpMethod": "PATCH", -"id": "saasservicemgmt.projects.locations.rollouts.patch", +"id": "saasservicemgmt.projects.locations.flagRevisions.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/rollout/{rollout_id}\"", +"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/flagRevisions/{flag_revision_id}\"", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/rollouts/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/flagRevisions/[^/]+$", "required": true, "type": "string" }, @@ -765,7 +765,7 @@ "type": "string" }, "updateMask": { -"description": "Field mask is used to specify the fields to be overwritten in the Rollout 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 in the Rollout will be overwritten.", +"description": "Field mask is used to specify the fields to be overwritten in the FlagRevision 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 in the FlagRevision will be overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -778,10 +778,10 @@ }, "path": "v1beta1/{+name}", "request": { -"$ref": "Rollout" +"$ref": "FlagRevision" }, "response": { -"$ref": "Rollout" +"$ref": "FlagRevision" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -789,19 +789,24 @@ } } }, -"saas": { +"flags": { "methods": { "create": { -"description": "Create a new saas.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/saas", +"description": "Create a new flag.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/flags", "httpMethod": "POST", -"id": "saasservicemgmt.projects.locations.saas.create", +"id": "saasservicemgmt.projects.locations.flags.create", "parameterOrder": [ "parent" ], "parameters": { +"flagId": { +"description": "Required. The ID value for the new flag.", +"location": "query", +"type": "string" +}, "parent": { -"description": "Required. The parent of the saas.", +"description": "Required. The parent of the flag.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -812,46 +817,41 @@ "location": "query", "type": "string" }, -"saasId": { -"description": "Required. The ID value for the new saas.", -"location": "query", -"type": "string" -}, "validateOnly": { "description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", "location": "query", "type": "boolean" } }, -"path": "v1beta1/{+parent}/saas", +"path": "v1beta1/{+parent}/flags", "request": { -"$ref": "Saas" +"$ref": "Flag" }, "response": { -"$ref": "Saas" +"$ref": "Flag" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Delete a single saas.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/saas/{saasId}", +"description": "Delete a single flag.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/flags/{flagsId}", "httpMethod": "DELETE", -"id": "saasservicemgmt.projects.locations.saas.delete", +"id": "saasservicemgmt.projects.locations.flags.delete", "parameterOrder": [ "name" ], "parameters": { "etag": { -"description": "The etag known to the client for the expected state of the saas. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the saas. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", +"description": "The etag known to the client for the expected state of the flag. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the flag. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", "location": "query", "type": "string" }, "name": { "description": "Required. The resource name of the resource within a service.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/saas/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/flags/[^/]+$", "required": true, "type": "string" }, @@ -875,10 +875,10 @@ ] }, "get": { -"description": "Retrieve a single saas.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/saas/{saasId}", +"description": "Retrieve a single flag.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/flags/{flagsId}", "httpMethod": "GET", -"id": "saasservicemgmt.projects.locations.saas.get", +"id": "saasservicemgmt.projects.locations.flags.get", "parameterOrder": [ "name" ], @@ -886,24 +886,24 @@ "name": { "description": "Required. The resource name of the resource within a service.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/saas/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/flags/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "Saas" +"$ref": "Flag" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Retrieve a collection of saas.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/saas", +"description": "Retrieve a collection of flags.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/flags", "httpMethod": "GET", -"id": "saasservicemgmt.projects.locations.saas.list", +"id": "saasservicemgmt.projects.locations.flags.list", "parameterOrder": [ "parent" ], @@ -919,7 +919,7 @@ "type": "string" }, "pageSize": { -"description": "The maximum number of saas to send per page.", +"description": "The maximum number of flags to send per page.", "format": "int32", "location": "query", "type": "integer" @@ -930,34 +930,34 @@ "type": "string" }, "parent": { -"description": "Required. The parent of the saas.", +"description": "Required. The parent of the flag.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/saas", +"path": "v1beta1/{+parent}/flags", "response": { -"$ref": "ListSaasResponse" +"$ref": "ListFlagsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { -"description": "Update a single saas.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/saas/{saasId}", +"description": "Update a single flag.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/flags/{flagsId}", "httpMethod": "PATCH", -"id": "saasservicemgmt.projects.locations.saas.patch", +"id": "saasservicemgmt.projects.locations.flags.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/saas/{saas}\"", +"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/flags/{flag_id}\"", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/saas/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/flags/[^/]+$", "required": true, "type": "string" }, @@ -967,7 +967,7 @@ "type": "string" }, "updateMask": { -"description": "Field mask is used to specify the fields to be overwritten in the Saas 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 in the Saas will be overwritten.", +"description": "Field mask is used to specify the fields to be overwritten in the Flag 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 in the Flag will be overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -980,10 +980,10 @@ }, "path": "v1beta1/{+name}", "request": { -"$ref": "Saas" +"$ref": "Flag" }, "response": { -"$ref": "Saas" +"$ref": "Flag" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -991,31 +991,31 @@ } } }, -"tenants": { +"releases": { "methods": { "create": { -"description": "Create a new tenant.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tenants", +"description": "Create a new release.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/releases", "httpMethod": "POST", -"id": "saasservicemgmt.projects.locations.tenants.create", +"id": "saasservicemgmt.projects.locations.releases.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The parent of the tenant.", +"description": "Required. The parent of the release.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"releaseId": { +"description": "Required. The ID value for the new release.", "location": "query", "type": "string" }, -"tenantId": { -"description": "Required. The ID value for the new tenant.", +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -1025,35 +1025,35 @@ "type": "boolean" } }, -"path": "v1beta1/{+parent}/tenants", +"path": "v1beta1/{+parent}/releases", "request": { -"$ref": "Tenant" +"$ref": "Release" }, "response": { -"$ref": "Tenant" +"$ref": "Release" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Delete a single tenant.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tenants/{tenantsId}", +"description": "Delete a single release.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/releases/{releasesId}", "httpMethod": "DELETE", -"id": "saasservicemgmt.projects.locations.tenants.delete", +"id": "saasservicemgmt.projects.locations.releases.delete", "parameterOrder": [ "name" ], "parameters": { "etag": { -"description": "The etag known to the client for the expected state of the tenant. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the tenant. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", +"description": "The etag known to the client for the expected state of the release. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the release. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", "location": "query", "type": "string" }, "name": { "description": "Required. The resource name of the resource within a service.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tenants/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/releases/[^/]+$", "required": true, "type": "string" }, @@ -1077,10 +1077,10 @@ ] }, "get": { -"description": "Retrieve a single tenant.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tenants/{tenantsId}", +"description": "Retrieve a single release.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/releases/{releasesId}", "httpMethod": "GET", -"id": "saasservicemgmt.projects.locations.tenants.get", +"id": "saasservicemgmt.projects.locations.releases.get", "parameterOrder": [ "name" ], @@ -1088,24 +1088,24 @@ "name": { "description": "Required. The resource name of the resource within a service.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tenants/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/releases/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "Tenant" +"$ref": "Release" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Retrieve a collection of tenants.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tenants", +"description": "Retrieve a collection of releases.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/releases", "httpMethod": "GET", -"id": "saasservicemgmt.projects.locations.tenants.list", +"id": "saasservicemgmt.projects.locations.releases.list", "parameterOrder": [ "parent" ], @@ -1121,7 +1121,7 @@ "type": "string" }, "pageSize": { -"description": "The maximum number of tenants to send per page.", +"description": "The maximum number of releases to send per page.", "format": "int32", "location": "query", "type": "integer" @@ -1132,34 +1132,34 @@ "type": "string" }, "parent": { -"description": "Required. The parent of the tenant.", +"description": "Required. The parent of the release.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/tenants", +"path": "v1beta1/{+parent}/releases", "response": { -"$ref": "ListTenantsResponse" +"$ref": "ListReleasesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { -"description": "Update a single tenant.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tenants/{tenantsId}", +"description": "Update a single release.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/releases/{releasesId}", "httpMethod": "PATCH", -"id": "saasservicemgmt.projects.locations.tenants.patch", +"id": "saasservicemgmt.projects.locations.releases.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/tenants/{tenant}\"", +"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/releases/{release}\"", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/tenants/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/releases/[^/]+$", "required": true, "type": "string" }, @@ -1169,7 +1169,7 @@ "type": "string" }, "updateMask": { -"description": "Field mask is used to specify the fields to be overwritten in the Tenant 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 in the Tenant will be overwritten.", +"description": "Field mask is used to specify the fields to be overwritten in the Release 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 in the Release will be overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1182,10 +1182,10 @@ }, "path": "v1beta1/{+name}", "request": { -"$ref": "Tenant" +"$ref": "Release" }, "response": { -"$ref": "Tenant" +"$ref": "Release" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -1193,19 +1193,19 @@ } } }, -"unitKinds": { +"rolloutKinds": { "methods": { "create": { -"description": "Create a new unit kind.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/unitKinds", +"description": "Create a new rollout kind.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/rolloutKinds", "httpMethod": "POST", -"id": "saasservicemgmt.projects.locations.unitKinds.create", +"id": "saasservicemgmt.projects.locations.rolloutKinds.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The parent of the unit kind.", +"description": "Required. The parent of the rollout kind.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1216,8 +1216,8 @@ "location": "query", "type": "string" }, -"unitKindId": { -"description": "Required. The ID value for the new unit kind.", +"rolloutKindId": { +"description": "Required. The ID value for the new rollout kind.", "location": "query", "type": "string" }, @@ -1227,35 +1227,35 @@ "type": "boolean" } }, -"path": "v1beta1/{+parent}/unitKinds", +"path": "v1beta1/{+parent}/rolloutKinds", "request": { -"$ref": "UnitKind" +"$ref": "RolloutKind" }, "response": { -"$ref": "UnitKind" +"$ref": "RolloutKind" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Delete a single unit kind.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/unitKinds/{unitKindsId}", +"description": "Delete a single rollout kind.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/rolloutKinds/{rolloutKindsId}", "httpMethod": "DELETE", -"id": "saasservicemgmt.projects.locations.unitKinds.delete", +"id": "saasservicemgmt.projects.locations.rolloutKinds.delete", "parameterOrder": [ "name" ], "parameters": { "etag": { -"description": "The etag known to the client for the expected state of the unit kind. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the unit kind. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", +"description": "The etag known to the client for the expected state of the rollout kind. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the rollout kind. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", "location": "query", "type": "string" }, "name": { "description": "Required. The resource name of the resource within a service.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/unitKinds/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/rolloutKinds/[^/]+$", "required": true, "type": "string" }, @@ -1279,10 +1279,10 @@ ] }, "get": { -"description": "Retrieve a single unit kind.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/unitKinds/{unitKindsId}", +"description": "Retrieve a single rollout kind.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/rolloutKinds/{rolloutKindsId}", "httpMethod": "GET", -"id": "saasservicemgmt.projects.locations.unitKinds.get", +"id": "saasservicemgmt.projects.locations.rolloutKinds.get", "parameterOrder": [ "name" ], @@ -1290,24 +1290,24 @@ "name": { "description": "Required. The resource name of the resource within a service.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/unitKinds/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/rolloutKinds/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "UnitKind" +"$ref": "RolloutKind" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Retrieve a collection of unit kinds.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/unitKinds", +"description": "Retrieve a collection of rollout kinds.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/rolloutKinds", "httpMethod": "GET", -"id": "saasservicemgmt.projects.locations.unitKinds.list", +"id": "saasservicemgmt.projects.locations.rolloutKinds.list", "parameterOrder": [ "parent" ], @@ -1323,7 +1323,7 @@ "type": "string" }, "pageSize": { -"description": "The maximum number of unit kinds to send per page.", +"description": "The maximum number of rollout kinds to send per page.", "format": "int32", "location": "query", "type": "integer" @@ -1334,34 +1334,34 @@ "type": "string" }, "parent": { -"description": "Required. The parent of the unit kind.", +"description": "Required. The parent of the rollout kind.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/unitKinds", +"path": "v1beta1/{+parent}/rolloutKinds", "response": { -"$ref": "ListUnitKindsResponse" +"$ref": "ListRolloutKindsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { -"description": "Update a single unit kind.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/unitKinds/{unitKindsId}", +"description": "Update a single rollout kind.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/rolloutKinds/{rolloutKindsId}", "httpMethod": "PATCH", -"id": "saasservicemgmt.projects.locations.unitKinds.patch", +"id": "saasservicemgmt.projects.locations.rolloutKinds.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/unitKinds/{unitKind}\"", +"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}\"", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/unitKinds/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/rolloutKinds/[^/]+$", "required": true, "type": "string" }, @@ -1371,7 +1371,7 @@ "type": "string" }, "updateMask": { -"description": "Field mask is used to specify the fields to be overwritten in the UnitKind 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 in the UnitKind will be overwritten.", +"description": "Field mask is used to specify the fields to be overwritten in the RolloutKind 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 in the RolloutKind will be overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1384,10 +1384,10 @@ }, "path": "v1beta1/{+name}", "request": { -"$ref": "UnitKind" +"$ref": "RolloutKind" }, "response": { -"$ref": "UnitKind" +"$ref": "RolloutKind" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -1395,19 +1395,19 @@ } } }, -"unitOperations": { +"rollouts": { "methods": { "create": { -"description": "Create a new unit operation.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/unitOperations", +"description": "Create a new rollout.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/rollouts", "httpMethod": "POST", -"id": "saasservicemgmt.projects.locations.unitOperations.create", +"id": "saasservicemgmt.projects.locations.rollouts.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The parent of the unit operation.", +"description": "Required. The parent of the rollout.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1418,8 +1418,8 @@ "location": "query", "type": "string" }, -"unitOperationId": { -"description": "Required. The ID value for the new unit operation.", +"rolloutId": { +"description": "Required. The ID value for the new rollout.", "location": "query", "type": "string" }, @@ -1429,35 +1429,35 @@ "type": "boolean" } }, -"path": "v1beta1/{+parent}/unitOperations", +"path": "v1beta1/{+parent}/rollouts", "request": { -"$ref": "UnitOperation" +"$ref": "Rollout" }, "response": { -"$ref": "UnitOperation" +"$ref": "Rollout" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Delete a single unit operation.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/unitOperations/{unitOperationsId}", +"description": "Delete a single rollout.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/rollouts/{rolloutsId}", "httpMethod": "DELETE", -"id": "saasservicemgmt.projects.locations.unitOperations.delete", +"id": "saasservicemgmt.projects.locations.rollouts.delete", "parameterOrder": [ "name" ], "parameters": { "etag": { -"description": "The etag known to the client for the expected state of the unit operation. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the unit operation. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", +"description": "The etag known to the client for the expected state of the rollout. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the rollout. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", "location": "query", "type": "string" }, "name": { "description": "Required. The resource name of the resource within a service.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/unitOperations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/rollouts/[^/]+$", "required": true, "type": "string" }, @@ -1481,10 +1481,10 @@ ] }, "get": { -"description": "Retrieve a single unit operation.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/unitOperations/{unitOperationsId}", +"description": "Retrieve a single rollout.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/rollouts/{rolloutsId}", "httpMethod": "GET", -"id": "saasservicemgmt.projects.locations.unitOperations.get", +"id": "saasservicemgmt.projects.locations.rollouts.get", "parameterOrder": [ "name" ], @@ -1492,24 +1492,24 @@ "name": { "description": "Required. The resource name of the resource within a service.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/unitOperations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/rollouts/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "UnitOperation" +"$ref": "Rollout" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Retrieve a collection of unit operations.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/unitOperations", +"description": "Retrieve a collection of rollouts.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/rollouts", "httpMethod": "GET", -"id": "saasservicemgmt.projects.locations.unitOperations.list", +"id": "saasservicemgmt.projects.locations.rollouts.list", "parameterOrder": [ "parent" ], @@ -1525,7 +1525,7 @@ "type": "string" }, "pageSize": { -"description": "The maximum number of unit operations to send per page.", +"description": "The maximum number of rollouts to send per page.", "format": "int32", "location": "query", "type": "integer" @@ -1536,34 +1536,34 @@ "type": "string" }, "parent": { -"description": "Required. The parent of the unit operation.", +"description": "Required. The parent of the rollout.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/unitOperations", +"path": "v1beta1/{+parent}/rollouts", "response": { -"$ref": "ListUnitOperationsResponse" +"$ref": "ListRolloutsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { -"description": "Update a single unit operation.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/unitOperations/{unitOperationsId}", +"description": "Update a single rollout.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/rollouts/{rolloutsId}", "httpMethod": "PATCH", -"id": "saasservicemgmt.projects.locations.unitOperations.patch", +"id": "saasservicemgmt.projects.locations.rollouts.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/unitOperations/{unitOperation}\"", +"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/rollout/{rollout_id}\"", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/unitOperations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/rollouts/[^/]+$", "required": true, "type": "string" }, @@ -1573,7 +1573,7 @@ "type": "string" }, "updateMask": { -"description": "Field mask is used to specify the fields to be overwritten in the UnitOperation 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 in the UnitOperation will be overwritten.", +"description": "Field mask is used to specify the fields to be overwritten in the Rollout 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 in the Rollout will be overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1586,10 +1586,10 @@ }, "path": "v1beta1/{+name}", "request": { -"$ref": "UnitOperation" +"$ref": "Rollout" }, "response": { -"$ref": "UnitOperation" +"$ref": "Rollout" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -1597,19 +1597,19 @@ } } }, -"units": { +"saas": { "methods": { "create": { -"description": "Create a new unit.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/units", +"description": "Create a new saas.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/saas", "httpMethod": "POST", -"id": "saasservicemgmt.projects.locations.units.create", +"id": "saasservicemgmt.projects.locations.saas.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { -"description": "Required. The parent of the unit.", +"description": "Required. The parent of the saas.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1620,8 +1620,8 @@ "location": "query", "type": "string" }, -"unitId": { -"description": "Required. The ID value for the new unit.", +"saasId": { +"description": "Required. The ID value for the new saas.", "location": "query", "type": "string" }, @@ -1631,35 +1631,35 @@ "type": "boolean" } }, -"path": "v1beta1/{+parent}/units", +"path": "v1beta1/{+parent}/saas", "request": { -"$ref": "Unit" +"$ref": "Saas" }, "response": { -"$ref": "Unit" +"$ref": "Saas" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Delete a single unit.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/units/{unitsId}", +"description": "Delete a single saas.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/saas/{saasId}", "httpMethod": "DELETE", -"id": "saasservicemgmt.projects.locations.units.delete", +"id": "saasservicemgmt.projects.locations.saas.delete", "parameterOrder": [ "name" ], "parameters": { "etag": { -"description": "The etag known to the client for the expected state of the unit. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the unit. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", +"description": "The etag known to the client for the expected state of the saas. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the saas. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", "location": "query", "type": "string" }, "name": { "description": "Required. The resource name of the resource within a service.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/units/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/saas/[^/]+$", "required": true, "type": "string" }, @@ -1683,10 +1683,10 @@ ] }, "get": { -"description": "Retrieve a single unit.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/units/{unitsId}", +"description": "Retrieve a single saas.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/saas/{saasId}", "httpMethod": "GET", -"id": "saasservicemgmt.projects.locations.units.get", +"id": "saasservicemgmt.projects.locations.saas.get", "parameterOrder": [ "name" ], @@ -1694,24 +1694,24 @@ "name": { "description": "Required. The resource name of the resource within a service.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/units/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/saas/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "Unit" +"$ref": "Saas" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { -"description": "Retrieve a collection of units.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/units", +"description": "Retrieve a collection of saas.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/saas", "httpMethod": "GET", -"id": "saasservicemgmt.projects.locations.units.list", +"id": "saasservicemgmt.projects.locations.saas.list", "parameterOrder": [ "parent" ], @@ -1727,7 +1727,7 @@ "type": "string" }, "pageSize": { -"description": "The maximum number of units to send per page.", +"description": "The maximum number of saas to send per page.", "format": "int32", "location": "query", "type": "integer" @@ -1738,34 +1738,34 @@ "type": "string" }, "parent": { -"description": "Required. The parent of the unit.", +"description": "Required. The parent of the saas.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/units", +"path": "v1beta1/{+parent}/saas", "response": { -"$ref": "ListUnitsResponse" +"$ref": "ListSaasResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { -"description": "Update a single unit.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/units/{unitsId}", +"description": "Update a single saas.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/saas/{saasId}", "httpMethod": "PATCH", -"id": "saasservicemgmt.projects.locations.units.patch", +"id": "saasservicemgmt.projects.locations.saas.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/units/{unit}\"", +"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/saas/{saas}\"", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/units/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/saas/[^/]+$", "required": true, "type": "string" }, @@ -1775,7 +1775,7 @@ "type": "string" }, "updateMask": { -"description": "Field mask is used to specify the fields to be overwritten in the Unit 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 in the Unit will be overwritten.", +"description": "Field mask is used to specify the fields to be overwritten in the Saas 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 in the Saas will be overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1788,156 +1788,1520 @@ }, "path": "v1beta1/{+name}", "request": { -"$ref": "Unit" +"$ref": "Saas" }, "response": { -"$ref": "Unit" +"$ref": "Saas" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } -} -} -} -} +}, +"tenants": { +"methods": { +"create": { +"description": "Create a new tenant.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tenants", +"httpMethod": "POST", +"id": "saasservicemgmt.projects.locations.tenants.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent of the tenant.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"tenantId": { +"description": "Required. The ID value for the new tenant.", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", +"location": "query", +"type": "boolean" } }, -"revision": "20260325", -"rootUrl": "https://saasservicemgmt.googleapis.com/", -"schemas": { -"Aggregate": { -"description": "Represents the aggregation of a set of population of like records by a certain group. For example, a collection of unit counts can be aggregated and grouped by their state.", -"id": "Aggregate", -"properties": { -"count": { -"description": "Required. Number of records in the group.", -"format": "int32", -"type": "integer" +"path": "v1beta1/{+parent}/tenants", +"request": { +"$ref": "Tenant" +}, +"response": { +"$ref": "Tenant" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Delete a single tenant.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tenants/{tenantsId}", +"httpMethod": "DELETE", +"id": "saasservicemgmt.projects.locations.tenants.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"etag": { +"description": "The etag known to the client for the expected state of the tenant. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the tenant. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The resource name of the resource within a service.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tenants/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Retrieve a single tenant.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tenants/{tenantsId}", +"httpMethod": "GET", +"id": "saasservicemgmt.projects.locations.tenants.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the resource within a service.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tenants/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Tenant" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Retrieve a collection of tenants.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tenants", +"httpMethod": "GET", +"id": "saasservicemgmt.projects.locations.tenants.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Filter the list as specified in https://google.aip.dev/160.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Order results as specified in https://google.aip.dev/132.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of tenants to send per page.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent of the tenant.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/tenants", +"response": { +"$ref": "ListTenantsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Update a single tenant.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tenants/{tenantsId}", +"httpMethod": "PATCH", +"id": "saasservicemgmt.projects.locations.tenants.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/tenants/{tenant}\"", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tenants/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Field mask is used to specify the fields to be overwritten in the Tenant 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 in the Tenant will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "Tenant" +}, +"response": { +"$ref": "Tenant" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"unitKinds": { +"methods": { +"create": { +"description": "Create a new unit kind.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/unitKinds", +"httpMethod": "POST", +"id": "saasservicemgmt.projects.locations.unitKinds.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent of the unit kind.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"unitKindId": { +"description": "Required. The ID value for the new unit kind.", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+parent}/unitKinds", +"request": { +"$ref": "UnitKind" +}, +"response": { +"$ref": "UnitKind" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Delete a single unit kind.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/unitKinds/{unitKindsId}", +"httpMethod": "DELETE", +"id": "saasservicemgmt.projects.locations.unitKinds.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"etag": { +"description": "The etag known to the client for the expected state of the unit kind. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the unit kind. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The resource name of the resource within a service.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/unitKinds/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Retrieve a single unit kind.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/unitKinds/{unitKindsId}", +"httpMethod": "GET", +"id": "saasservicemgmt.projects.locations.unitKinds.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the resource within a service.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/unitKinds/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "UnitKind" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Retrieve a collection of unit kinds.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/unitKinds", +"httpMethod": "GET", +"id": "saasservicemgmt.projects.locations.unitKinds.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Filter the list as specified in https://google.aip.dev/160.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Order results as specified in https://google.aip.dev/132.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of unit kinds to send per page.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent of the unit kind.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/unitKinds", +"response": { +"$ref": "ListUnitKindsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Update a single unit kind.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/unitKinds/{unitKindsId}", +"httpMethod": "PATCH", +"id": "saasservicemgmt.projects.locations.unitKinds.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/unitKinds/{unitKind}\"", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/unitKinds/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Field mask is used to specify the fields to be overwritten in the UnitKind 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 in the UnitKind will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "UnitKind" +}, +"response": { +"$ref": "UnitKind" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"unitOperations": { +"methods": { +"create": { +"description": "Create a new unit operation.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/unitOperations", +"httpMethod": "POST", +"id": "saasservicemgmt.projects.locations.unitOperations.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent of the unit operation.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"unitOperationId": { +"description": "Required. The ID value for the new unit operation.", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+parent}/unitOperations", +"request": { +"$ref": "UnitOperation" +}, +"response": { +"$ref": "UnitOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Delete a single unit operation.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/unitOperations/{unitOperationsId}", +"httpMethod": "DELETE", +"id": "saasservicemgmt.projects.locations.unitOperations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"etag": { +"description": "The etag known to the client for the expected state of the unit operation. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the unit operation. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The resource name of the resource within a service.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/unitOperations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Retrieve a single unit operation.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/unitOperations/{unitOperationsId}", +"httpMethod": "GET", +"id": "saasservicemgmt.projects.locations.unitOperations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the resource within a service.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/unitOperations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "UnitOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Retrieve a collection of unit operations.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/unitOperations", +"httpMethod": "GET", +"id": "saasservicemgmt.projects.locations.unitOperations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Filter the list as specified in https://google.aip.dev/160.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Order results as specified in https://google.aip.dev/132.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of unit operations to send per page.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent of the unit operation.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/unitOperations", +"response": { +"$ref": "ListUnitOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Update a single unit operation.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/unitOperations/{unitOperationsId}", +"httpMethod": "PATCH", +"id": "saasservicemgmt.projects.locations.unitOperations.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/unitOperations/{unitOperation}\"", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/unitOperations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Field mask is used to specify the fields to be overwritten in the UnitOperation 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 in the UnitOperation will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "UnitOperation" +}, +"response": { +"$ref": "UnitOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"units": { +"methods": { +"create": { +"description": "Create a new unit.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/units", +"httpMethod": "POST", +"id": "saasservicemgmt.projects.locations.units.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent of the unit.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"unitId": { +"description": "Required. The ID value for the new unit.", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+parent}/units", +"request": { +"$ref": "Unit" +}, +"response": { +"$ref": "Unit" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Delete a single unit.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/units/{unitsId}", +"httpMethod": "DELETE", +"id": "saasservicemgmt.projects.locations.units.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"etag": { +"description": "The etag known to the client for the expected state of the unit. This is used with state-changing methods to prevent accidental overwrites when multiple user agents might be acting in parallel on the same resource. An etag wildcard provide optimistic concurrency based on the expected existence of the unit. The Any wildcard (`*`) requires that the resource must already exists, and the Not Any wildcard (`!*`) requires that it must not.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The resource name of the resource within a service.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/units/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Retrieve a single unit.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/units/{unitsId}", +"httpMethod": "GET", +"id": "saasservicemgmt.projects.locations.units.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the resource within a service.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/units/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Unit" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Retrieve a collection of units.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/units", +"httpMethod": "GET", +"id": "saasservicemgmt.projects.locations.units.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Filter the list as specified in https://google.aip.dev/160.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Order results as specified in https://google.aip.dev/132.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of units to send per page.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent of the unit.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/units", +"response": { +"$ref": "ListUnitsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Update a single unit.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/units/{unitsId}", +"httpMethod": "PATCH", +"id": "saasservicemgmt.projects.locations.units.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/units/{unit}\"", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/units/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Field mask is used to specify the fields to be overwritten in the Unit 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 in the Unit will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "If \"validate_only\" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "Unit" +}, +"response": { +"$ref": "Unit" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +}, +"revision": "20260407", +"rootUrl": "https://saasservicemgmt.googleapis.com/", +"schemas": { +"Aggregate": { +"description": "Represents the aggregation of a set of population of like records by a certain group. For example, a collection of unit counts can be aggregated and grouped by their state.", +"id": "Aggregate", +"properties": { +"count": { +"description": "Required. Number of records in the group.", +"format": "int32", +"type": "integer" +}, +"group": { +"description": "Required. Group by which to aggregate.", +"type": "string" +} +}, +"type": "object" +}, +"Allocation": { +"description": "Allocation defines a set of weighted flag variants, specifying how traffic is split based on the randomization unit.", +"id": "Allocation", +"properties": { +"description": { +"description": "Optional. Description of the allocation. Max length: 500 bytes.", +"type": "string" +}, +"id": { +"description": "Required. Allocation ID. Max length: 128 bytes.", +"type": "string" +}, +"randomizedOn": { +"description": "Required. Key of the context attribute that is used for traffic splitting.", +"type": "string" +}, +"slots": { +"description": "Required. Slots defines the weighted distribution of variants.", +"items": { +"$ref": "AllocationSlot" +}, +"type": "array" +} +}, +"type": "object" +}, +"AllocationSlot": { +"description": "AllocationSlot specifies a variant and the proportion of traffic allocated to it.", +"id": "AllocationSlot", +"properties": { +"variant": { +"description": "Required. Variant of the allocation slot.", +"type": "string" +}, +"weight": { +"description": "Required. Weight defines the proportion of traffic to allocate to the variant, relative to other slots in the same allocation.", +"format": "int32", +"type": "integer" +} +}, +"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 TYPE_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", +"properties": { +"engine": { +"description": "Output only. Type of the engine used to actuate the blueprint. e.g. terraform, helm etc.", +"readOnly": true, +"type": "string" +}, +"package": { +"description": "Optional. Immutable. URI to a blueprint used by the Unit (required unless unitKind or release is set).", +"type": "string" +}, +"version": { +"description": "Output only. Version metadata if present on the blueprint.", +"readOnly": true, +"type": "string" +} +}, +"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", +"properties": { +"alias": { +"description": "Required. An alias for the dependency. Used for input variable mapping.", +"type": "string" +}, +"unitKind": { +"description": "Required. Immutable. The unit kind of the dependency.", +"type": "string" +} +}, +"type": "object" +}, +"Deprovision": { +"description": "Deprovision is the unit operation that deprovision the underlying resources represented by a Unit. Can only execute if the Unit is currently provisioned.", +"id": "Deprovision", +"properties": {}, +"type": "object" +}, +"Empty": { +"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", +"id": "Empty", +"properties": {}, +"type": "object" +}, +"ErrorBudget": { +"description": "The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused.", +"id": "ErrorBudget", +"properties": { +"allowedCount": { +"description": "Optional. The maximum number of failed units allowed in a location without pausing the rollout.", +"format": "int32", +"type": "integer" +}, +"allowedPercentage": { +"description": "Optional. The maximum percentage of units allowed to fail (0, 100] within a location without pausing the rollout.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"EvaluationRule": { +"description": "EvaluationRule defines a single rule for evaluating a feature flag. A rule consists of a condition that, if met, assigns a specific variant or allocation to the user.", +"id": "EvaluationRule", +"properties": { +"condition": { +"description": "Required. A Common Expression Language (CEL) expression that evaluates to a boolean. The expression is evaluated against the provided context. If it returns true, the rule's target is applied.", +"type": "string" +}, +"id": { +"description": "Required. Evaluation rule ID. Max length: 128 bytes.", +"type": "string" +}, +"target": { +"description": "Required. The target variant or allocation to apply if the condition is met. This should match the name of a defined variant or allocation's ID.", +"type": "string" +} +}, +"type": "object" +}, +"EvaluationSpec": { +"description": "EvaluationSpec holds rules for evaluating the value of a flag.", +"id": "EvaluationSpec", +"properties": { +"allocations": { +"description": "Optional. A list of allocations.", +"items": { +"$ref": "Allocation" +}, +"type": "array" +}, +"attributes": { +"description": "Optional. Names of the context attributes that are used in the evaluation rules and allocations.", +"items": { +"type": "string" +}, +"type": "array" +}, +"defaultTarget": { +"description": "Required. Default variant or allocation of the flag.", +"type": "string" +}, +"rules": { +"description": "Optional. Evaluation rules define the logic for evaluating the flag against a given context. The rules are evaluated sequentially in their specified order.", +"items": { +"$ref": "EvaluationRule" +}, +"type": "array" +}, +"variants": { +"deprecated": true, +"description": "Optional. A list of variants.", +"items": { +"$ref": "Variant" +}, +"type": "array" +} +}, +"type": "object" +}, +"Flag": { +"description": "Represents a single Flag.", +"id": "Flag", +"properties": { +"annotations": { +"additionalProperties": { +"type": "string" +}, +"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" +}, +"createTime": { +"description": "Output only. The timestamp when the resource was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. Description of the flag. Max length: 500 bytes.", +"type": "string" +}, +"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, +"type": "string" +}, +"evaluationSpec": { +"$ref": "EvaluationSpec", +"description": "Optional. Specification of how the flag value should be evaluated. If a bool flag is created without an evaluation_spec specified, two default variants, \"Enabled\" (with bool_value = true) and \"Disabled\" (with bool_value = false), are created by default, and \"Disabled\" is set as the default_target." +}, +"flagSet": { +"description": "Optional. Flag set this flag belongs to.", +"type": "string" +}, +"flagValueType": { +"description": "Optional. Immutable. Flag value type.", +"enum": [ +"FLAG_VALUE_TYPE_UNSPECIFIED", +"FLAG_VALUE_TYPE_BOOLEAN", +"FLAG_VALUE_TYPE_INTEGER", +"FLAG_VALUE_TYPE_STRING", +"FLAG_VALUE_TYPE_DOUBLE" +], +"enumDescriptions": [ +"Unspecified flag value type.", +"Boolean flag value type.", +"Integer flag value type.", +"String flag value type.", +"Double flag value type." +], +"type": "string" +}, +"key": { +"description": "Required. Immutable. Flag key used in runtime evaluation APIs (OpenFeature). Max length: 256 bytes.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.", +"type": "object" +}, +"name": { +"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/flags/{flag_id}\"", +"type": "string" +}, +"state": { +"description": "Optional. Current state of the flag.", +"enum": [ +"FLAG_STATE_UNSPECIFIED", +"FLAG_STATE_IN_DEVELOPMENT", +"FLAG_STATE_ACTIVE", +"FLAG_STATE_SUNSETTING", +"FLAG_STATE_CLEANUP" +], +"enumDescriptions": [ +"Flag state is unspecified.", +"Flag is in development state.", +"Flag is in active state.", +"Flag is in deprecated state.", +"Flag is in cleanup state." +], +"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, +"type": "string" +}, +"unitKind": { +"description": "Required. Immutable. UnitKind that can consume this flag.", +"type": "string" +}, +"updateTime": { +"description": "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.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"valueType": { +"deprecated": true, +"description": "Optional. Immutable. Deprecated: Use `flag_value_type` instead. Flag value type.", +"enum": [ +"FLAG_VALUE_TYPE_UNSPECIFIED", +"FLAG_VALUE_TYPE_BOOL", +"FLAG_VALUE_TYPE_INT", +"FLAG_VALUE_TYPE_STRING", +"FLAG_VALUE_TYPE_DOUBLE" +], +"enumDescriptions": [ +"", +"Boolean flag value type.", +"Integer flag value type.", +"String flag value type.", +"Double flag type." +], +"type": "string" +}, +"variants": { +"description": "Optional. A list of variants.", +"items": { +"$ref": "FlagVariant" +}, +"type": "array" +} +}, +"type": "object" +}, +"FlagAttribute": { +"description": "FlagAttribute defines a custom property in the evaluation context.", +"id": "FlagAttribute", +"properties": { +"annotations": { +"additionalProperties": { +"type": "string" +}, +"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" +}, +"attributeValueType": { +"description": "Optional. Immutable. Type of the attribute.", +"enum": [ +"FLAG_ATTRIBUTE_VALUE_TYPE_UNSPECIFIED", +"FLAG_ATTRIBUTE_VALUE_TYPE_BOOLEAN", +"FLAG_ATTRIBUTE_VALUE_TYPE_INTEGER", +"FLAG_ATTRIBUTE_VALUE_TYPE_STRING", +"FLAG_ATTRIBUTE_VALUE_TYPE_DOUBLE" +], +"enumDescriptions": [ +"Unspecified flag attribute value type.", +"Boolean flag attribute value type.", +"Integer flag attribute value type.", +"String flag attribute value type.", +"Double flag attribute value type." +], +"type": "string" +}, +"createTime": { +"description": "Output only. The timestamp when the resource was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"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, +"type": "string" +}, +"key": { +"description": "Required. Immutable. The identifier for the attribute, used as the key in the evaluation context. The attribute key is referenced in the evaluation rules and used in the OpenFeature evaluation API to specify the attribute context.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.", +"type": "object" +}, +"name": { +"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/flagAttributes/{flag_attribute_id}\"", +"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, +"type": "string" +}, +"updateTime": { +"description": "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.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"valueType": { +"deprecated": true, +"description": "Optional. Immutable. Deprecated: Use `attribute_value_type` instead. Type of the attribute.", +"enum": [ +"FLAG_ATTRIBUTE_VALUE_TYPE_UNSPECIFIED", +"BOOLEAN", +"INTEGER", +"STRING", +"DOUBLE" +], +"enumDescriptions": [ +"Unspecified flag attribute value type.", +"Boolean flag attribute value type.", +"Integer flag attribute value type.", +"String flag attribute value type.", +"Double flag attribute value type." +], +"type": "string" +} +}, +"type": "object" +}, +"FlagRelease": { +"description": "A collection of FlagRevisions.", +"id": "FlagRelease", +"properties": { +"allFlags": { +"deprecated": true, +"description": "Optional. Immutable. DEPRECATED: Use all_flags_release instead. Rollout all flags in the provided UnitKind. Only one of flag_revisions, all_flags, or flag_sets can be set.", +"type": "boolean" +}, +"allFlagsRelease": { +"description": "Optional. Immutable. Specifies the release includes all flags.", +"type": "boolean" +}, +"annotations": { +"additionalProperties": { +"type": "string" +}, +"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" +}, +"createTime": { +"description": "Output only. The timestamp when the resource was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"effectiveFlagRevisions": { +"description": "Output only. An OUTPUT_ONLY field that contains FlagRevisions to be rolled out. This is the ultimate source of truth of what a Rollout or a UnitOperation carries.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"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, +"type": "string" +}, +"flagRevisions": { +"deprecated": true, +"description": "Optional. Immutable. DEPRECATED: Use flag_revisions_release instead. FlagRevisions to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. It used to be the ultimate source to truth and has been moved to effective_flag_revisions.", +"items": { +"type": "string" +}, +"type": "array" +}, +"flagRevisionsRelease": { +"$ref": "FlagRevisionList", +"description": "Optional. Immutable. Specifies the release consists of a list of flag revisions." +}, +"flagSets": { +"deprecated": true, +"description": "Optional. Immutable. DEPRECATED: Use flag_sets_release instead. Flag sets to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set.", +"items": { +"type": "string" +}, +"type": "array" +}, +"flagSetsRelease": { +"$ref": "FlagSetList", +"description": "Optional. Immutable. Specifies the release consists of a list of flag sets." +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.", +"type": "object" +}, +"name": { +"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/flagReleases/{flag_release_id}\"", +"type": "string" +}, +"obsoleteFlags": { +"deprecated": true, +"description": "Optional. Immutable. Deprecated: Use the 'state' field in the 'Flag' resource to manage the cleanup of flag lifecycles including removal from UnitKind and Units. Flags to be removed from given UnitKind and all related Units. If Flag is provided here, its FlagRevisions will be removed from UnitKind and Units.", +"items": { +"type": "string" +}, +"type": "array" +}, +"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, +"type": "string" }, -"group": { -"description": "Required. Group by which to aggregate.", +"unitKind": { +"description": "Required. Immutable. The UnitKind this FlagRelease applies to.", +"type": "string" +}, +"updateTime": { +"description": "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.", +"format": "google-datetime", +"readOnly": true, "type": "string" } }, "type": "object" }, -"AppParams": { -"description": "AppParams contains the parameters for creating an AppHub Application.", -"id": "AppParams", +"FlagRevision": { +"description": "A snapshot of the EvaluationSpec for the Flag.", +"id": "FlagRevision", "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", +"annotations": { +"additionalProperties": { "type": "string" }, -"scope": { -"$ref": "Scope", -"description": "Corresponds to the scope in the ADC composite ApplicationTemplate. Defaults to REGIONAL." -} -}, +"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" }, -"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", -"properties": { -"engine": { -"description": "Output only. Type of the engine used to actuate the blueprint. e.g. terraform, helm etc.", +"createTime": { +"description": "Output only. The timestamp when the resource was created.", +"format": "google-datetime", "readOnly": true, "type": "string" }, -"package": { -"description": "Optional. Immutable. URI to a blueprint used by the Unit (required unless unitKind or release is set).", -"type": "string" -}, -"version": { -"description": "Output only. Version metadata if present on the blueprint.", +"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, "type": "string" -} }, -"type": "object" +"evaluationSpec": { +"$ref": "EvaluationSpec", +"deprecated": true, +"description": "Output only. Immutable. Snapshot of the EvaluationSpec for the flag. DEPRECATED: Use snapshot instead.", +"readOnly": true }, -"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", +"flag": { +"description": "Required. Immutable. Name of the Flag this is a revision of.", "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.", +"labels": { +"additionalProperties": { "type": "string" -} }, +"description": "Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.", "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.", +"name": { +"description": "Identifier. The resource name (full URI of the resource) following the standard naming scheme: \"projects/{project}/locations/{location}/flagRevisions/{flag_revision_id}\"", "type": "string" }, -"revision": { -"description": "Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored.", +"snapshot": { +"$ref": "Flag", +"description": "Output only. Immutable. Snapshot of the Flag.", +"readOnly": true +}, +"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, "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.", +"updateTime": { +"description": "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.", +"format": "google-datetime", "readOnly": true, "type": "string" } }, "type": "object" }, -"Dependency": { -"description": "Dependency represent a single dependency with another unit kind by alias.", -"id": "Dependency", +"FlagRevisionList": { +"description": "Wrapper for a list of flag revisions.", +"id": "FlagRevisionList", "properties": { -"alias": { -"description": "Required. An alias for the dependency. Used for input variable mapping.", +"revisions": { +"description": "Required. FlagRevisions to be rolled out.", +"items": { "type": "string" }, -"unitKind": { -"description": "Required. Immutable. The unit kind of the dependency.", -"type": "string" +"type": "array" } }, "type": "object" }, -"Deprovision": { -"description": "Deprovision is the unit operation that deprovision the underlying resources represented by a Unit. Can only execute if the Unit is currently provisioned.", -"id": "Deprovision", -"properties": {}, +"FlagSetList": { +"description": "Wrapper for a list of flag sets.", +"id": "FlagSetList", +"properties": { +"sets": { +"description": "Required. Flag sets to be rolled out.", +"items": { +"type": "string" +}, +"type": "array" +} +}, "type": "object" }, -"Empty": { -"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", -"id": "Empty", -"properties": {}, +"FlagUpdate": { +"description": "FlagUpdate is a UnitOperation that pushes new flag values to Units.", +"id": "FlagUpdate", +"properties": { +"flagRelease": { +"description": "Required. Flag release being applied by UnitOperation.", +"type": "string" +} +}, "type": "object" }, -"ErrorBudget": { -"description": "The configuration for error budget. If the number of failed units exceeds max(allowed_count, allowed_ratio * total_units), the rollout will be paused.", -"id": "ErrorBudget", +"FlagVariant": { +"description": "Variant is an identifier for a value (name assigned to a value).", +"id": "FlagVariant", "properties": { -"allowedCount": { -"description": "Optional. The maximum number of failed units allowed in a location without pausing the rollout.", -"format": "int32", -"type": "integer" +"booleanValue": { +"description": "Optional. Boolean variant value.", +"type": "boolean" }, -"allowedPercentage": { -"description": "Optional. The maximum percentage of units allowed to fail (0, 100] within a location without pausing the rollout.", -"format": "int32", -"type": "integer" +"description": { +"description": "Optional. A human-readable description of what this variant does or represents.", +"type": "string" +}, +"doubleValue": { +"description": "Optional. Double variant value.", +"format": "double", +"type": "number" +}, +"id": { +"description": "Required. Variant ID. Max length: 128 bytes.", +"type": "string" +}, +"integerValue": { +"description": "Optional. Integer variant value.", +"format": "int64", +"type": "string" +}, +"stringValue": { +"description": "Optional. String variant value.", +"type": "string" +}, +"trackingId": { +"description": "Optional. trackingId is unique depending on name and value of the variant within the scope of the service. It is typically generated by the server and must not be changed. trackingId is used to uniquely identify and track variants.", +"type": "string" } }, "type": "object" @@ -1991,6 +3355,106 @@ }, "type": "object" }, +"ListFlagAttributesResponse": { +"description": "The response structure for the ListFlagAttributes method.", +"id": "ListFlagAttributesResponse", +"properties": { +"flagAttributes": { +"description": "The resulting flag attributes.", +"items": { +"$ref": "FlagAttribute" +}, +"type": "array" +}, +"nextPageToken": { +"description": "If present, the next page token can be provided to a subsequent ListFlagAttributes call to list the next page. If empty, there are no more pages.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListFlagReleasesResponse": { +"description": "The response structure for the ListFlagReleases method.", +"id": "ListFlagReleasesResponse", +"properties": { +"flagReleases": { +"description": "The resulting flag releases.", +"items": { +"$ref": "FlagRelease" +}, +"type": "array" +}, +"nextPageToken": { +"description": "If present, the next page token can be provided to a subsequent ListFlagReleases call to list the next page. If empty, there are no more pages.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListFlagRevisionsResponse": { +"description": "The response structure for the ListFlagRevisions method.", +"id": "ListFlagRevisionsResponse", +"properties": { +"flagRevisions": { +"description": "The resulting flag revisions.", +"items": { +"$ref": "FlagRevision" +}, +"type": "array" +}, +"nextPageToken": { +"description": "If present, the next page token can be provided to a subsequent ListFlagRevisions call to list the next page. If empty, there are no more pages.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListFlagsResponse": { +"description": "The response structure for the ListFlags method.", +"id": "ListFlagsResponse", +"properties": { +"flags": { +"description": "The resulting flags.", +"items": { +"$ref": "Flag" +}, +"type": "array" +}, +"nextPageToken": { +"description": "If present, the next page token can be provided to a subsequent ListFlags call to list the next page. If empty, there are no more pages.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "ListLocationsResponse", @@ -2394,6 +3858,10 @@ "readOnly": true, "type": "string" }, +"flagRelease": { +"description": "Optional. Immutable. Name of the FlagRelease to be rolled out to the target Units. Release and FlagRelease are mutually exclusive. Note: `release` comment needs to be adjusted to mention that \"Release and FlagRelease are mutually exclusive\" when visibility restriction will be lifted.", +"type": "string" +}, "labels": { "additionalProperties": { "type": "string" @@ -2698,30 +4166,30 @@ "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" +"STATE_FAILED", +"ACTIVE", +"RUNNING", +"FAILED" ], "enumDeprecated": [ false, -true, -true, -true, false, false, -false +false, +true, +true, +true ], "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" +"Failure during process of importing, synchronizing or replicating ApplicationTemplate processing", +"Deprecated: Use STATE_ACTIVE.", +"Deprecated: Use STATE_RUNNING.", +"Deprecated: Use STATE_FAILED." ], "readOnly": true, "type": "string" @@ -2810,24 +4278,24 @@ false "description": "Required. Scope Type.", "enum": [ "TYPE_UNSPECIFIED", -"REGIONAL", -"GLOBAL", "TYPE_REGIONAL", -"TYPE_GLOBAL" +"TYPE_GLOBAL", +"REGIONAL", +"GLOBAL" ], "enumDeprecated": [ false, -true, -true, false, -false +false, +true, +true ], "enumDescriptions": [ "Unspecified type.", -"Deprecated: Use TYPE_REGIONAL.", -"Deprecated: Use TYPE_GLOBAL.", "Regional type.", -"Global type." +"Global type.", +"Deprecated: Use TYPE_REGIONAL.", +"Deprecated: Use TYPE_GLOBAL." ], "type": "string" } @@ -2873,7 +4341,7 @@ false "type": "object" }, "consumerResource": { -"description": "Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by SaaS Runtime for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API).", +"description": "Optional. Immutable. A reference to the consumer resource this SaaS Tenant is representing. The relationship with a consumer resource can be used by App Lifecycle Manager for retrieving consumer-defined settings and policies such as maintenance policies (using Unified Maintenance Policy API).", "type": "string" }, "createTime": { @@ -2899,7 +4367,7 @@ false "type": "string" }, "saas": { -"description": "Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model.", +"description": "Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model.", "type": "string" }, "uid": { @@ -2925,7 +4393,7 @@ false "type": "string" }, "ignoreForLookup": { -"description": "Optional. Tells SaaS Runtime if this mapping should be used during lookup or not", +"description": "Optional. Tells App Lifecycle Manager if this mapping should be used during lookup or not", "type": "boolean" }, "inputVariable": { @@ -2985,6 +4453,19 @@ false "readOnly": true, "type": "string" }, +"flagConfigName": { +"description": "Output only. This field stores the unique identifier for the flag configuration to be used by this Unit.", +"readOnly": true, +"type": "string" +}, +"flagRevisions": { +"description": "Optional. Output only. Flag revisions used by this Unit.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "inputVariables": { "description": "Optional. Output only. Indicates the current input variables deployed by the unit", "items": { @@ -3234,6 +4715,13 @@ false "readOnly": true, "type": "string" }, +"defaultFlagRevisions": { +"description": "Optional. Default revisions of flags for this UnitKind. Newly created units will use the flag default_flag_revisions present at the time of creation.", +"items": { +"type": "string" +}, +"type": "array" +}, "defaultRelease": { "description": "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.", "type": "string" @@ -3276,7 +4764,7 @@ false "type": "array" }, "saas": { -"description": "Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with SaaS Runtime. Part of the SaaS Runtime common data model. Immutable once set.", +"description": "Required. Immutable. A reference to the Saas that defines the product (managed service) that the producer wants to manage with App Lifecycle Manager. Part of the App Lifecycle Manager common data model. Immutable once set.", "type": "string" }, "uid": { @@ -3362,6 +4850,9 @@ false "readOnly": true, "type": "string" }, +"flagUpdate": { +"$ref": "FlagUpdate" +}, "labels": { "additionalProperties": { "type": "string" @@ -3500,13 +4991,17 @@ false "TYPE_UNSPECIFIED", "STRING", "INT", -"BOOL" +"BOOL", +"STRUCT", +"LIST" ], "enumDescriptions": [ "Variable type is unspecified.", "Variable type is string.", "Variable type is int.", -"Variable type is bool." +"Variable type is bool.", +"Variable type is struct.", +"Variable type is list." ], "type": "string" }, @@ -3557,10 +5052,39 @@ false } }, "type": "object" +}, +"Variant": { +"description": "Variant is an identifier for a value (name assigned to a value). DEPRECATED: Use Flag.Variants instead.", +"id": "Variant", +"properties": { +"boolValue": { +"description": "Optional. Boolean flag value.", +"type": "boolean" +}, +"doubleValue": { +"description": "Optional. Double flag value.", +"format": "double", +"type": "number" +}, +"intValue": { +"description": "Optional. Integer flag value.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "Required. Name of the variant. Max length: 128 bytes.", +"type": "string" +}, +"stringValue": { +"description": "Optional. String flag value.", +"type": "string" +} +}, +"type": "object" } }, "servicePath": "", -"title": "SaaS Runtime API", +"title": "App Lifecycle Manager API", "version": "v1beta1", "version_module": true } \ No newline at end of file From 3832566dd01e89a33daea7bdbcdae0205e2701ab Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:41:01 +0000 Subject: [PATCH 27/32] feat(secretmanager): update the api #### secretmanager:v1beta2 The following keys were added: - schemas.OperationMetadata.properties.progress (Total Keys: 2) - schemas.Progress (Total Keys: 11) --- ...retmanager_v1beta2.projects.locations.html | 4 +- .../documents/secretmanager.v1beta2.json | 38 +++++++++++++++++-- 2 files changed, 36 insertions(+), 6 deletions(-) diff --git a/docs/dyn/secretmanager_v1beta2.projects.locations.html b/docs/dyn/secretmanager_v1beta2.projects.locations.html index ee81b53a5d..5318b9fd0a 100644 --- a/docs/dyn/secretmanager_v1beta2.projects.locations.html +++ b/docs/dyn/secretmanager_v1beta2.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/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json b/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json
index 9e053c42f6..41c83bc921 100644
--- a/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json
+++ b/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json
@@ -387,7 +387,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": "v1beta2/projects/{projectsId}/locations",
 "httpMethod": "GET",
 "id": "secretmanager.projects.locations.list",
@@ -1366,7 +1366,7 @@
 }
 }
 },
-"revision": "20260213",
+"revision": "20260327",
 "rootUrl": "https://secretmanager.googleapis.com/",
 "schemas": {
 "AccessSecretVersionResponse": {
@@ -1715,17 +1715,22 @@
 "type": "string"
 },
 "createTime": {
-"description": "Output only. The time the operation was created.",
+"description": "Output only. Time the operation was created.",
 "format": "google-datetime",
 "readOnly": true,
 "type": "string"
 },
 "endTime": {
-"description": "Output only. The time the operation finished running.",
+"description": "Output only. Time the operation finished running.",
 "format": "google-datetime",
 "readOnly": true,
 "type": "string"
 },
+"progress": {
+"$ref": "Progress",
+"description": "Output only. Represents the progress of the operation. This field is populated for operations that involve processing multiple secret versions.",
+"readOnly": true
+},
 "requestedCancellation": {
 "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
 "readOnly": true,
@@ -1780,6 +1785,31 @@
 },
 "type": "object"
 },
+"Progress": {
+"description": "Represents progress information for operations involving multiple secret versions.",
+"id": "Progress",
+"properties": {
+"completedVersionCount": {
+"description": "Output only. Number of secret versions that have been successfully processed so far.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"failedVersionCount": {
+"description": "Output only. Number of secret versions that failed to process.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"totalVersionCount": {
+"description": "Output only. Provides the total number of secret versions to be processed by the operation.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+}
+},
+"type": "object"
+},
 "Replica": {
 "description": "Represents a Replica for this Secret.",
 "id": "Replica",

From 652b925ed6d2458a18a1ac10ef753355c357c941 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 14 Apr 2026 07:41:01 +0000
Subject: [PATCH 28/32] feat(storage): update the api

#### storage:v1

The following keys were added:
- schemas.AnywhereCache.properties.ingestOnWrite.type (Total Keys: 1)
---
 docs/dyn/storage_v1.anywhereCaches.html               | 11 +++++++++--
 .../discovery_cache/documents/storage.v1.json         | 10 +++++++---
 2 files changed, 16 insertions(+), 5 deletions(-)

diff --git a/docs/dyn/storage_v1.anywhereCaches.html b/docs/dyn/storage_v1.anywhereCaches.html
index 2ad387fc68..aa8428b052 100644
--- a/docs/dyn/storage_v1.anywhereCaches.html
+++ b/docs/dyn/storage_v1.anywhereCaches.html
@@ -100,7 +100,7 @@ 

Instance Methods

Resumes a paused or disabled Anywhere Cache instance.

update(bucket, anywhereCacheId, body=None)

-

Updates the config(ttl and admissionPolicy) of an Anywhere Cache instance.

+

Updates the config of an Anywhere Cache instance.

Method Details

close() @@ -124,6 +124,7 @@

Method Details

"bucket": "A String", # The name of the bucket containing this cache instance. "createTime": "A String", # The creation time of the cache instance in RFC 3339 format. "id": "A String", # The ID of the resource, including the project number, bucket name and anywhere cache ID. + "ingestOnWrite": True or False, # Specifies whether objects are ingested into the cache upon write. "kind": "storage#anywhereCache", # The kind of item this is. For Anywhere Cache, this is always storage#anywhereCache. "pendingUpdate": True or False, # True if the cache instance has an active Update long-running operation. "selfLink": "A String", # The link to this cache instance. @@ -151,6 +152,7 @@

Method Details

"bucket": "A String", # The name of the bucket containing this cache instance. "createTime": "A String", # The creation time of the cache instance in RFC 3339 format. "id": "A String", # The ID of the resource, including the project number, bucket name and anywhere cache ID. + "ingestOnWrite": True or False, # Specifies whether objects are ingested into the cache upon write. "kind": "storage#anywhereCache", # The kind of item this is. For Anywhere Cache, this is always storage#anywhereCache. "pendingUpdate": True or False, # True if the cache instance has an active Update long-running operation. "selfLink": "A String", # The link to this cache instance. @@ -176,6 +178,7 @@

Method Details

"bucket": "A String", # The name of the bucket containing this cache instance. "createTime": "A String", # The creation time of the cache instance in RFC 3339 format. "id": "A String", # The ID of the resource, including the project number, bucket name and anywhere cache ID. + "ingestOnWrite": True or False, # Specifies whether objects are ingested into the cache upon write. "kind": "storage#anywhereCache", # The kind of item this is. For Anywhere Cache, this is always storage#anywhereCache. "pendingUpdate": True or False, # True if the cache instance has an active Update long-running operation. "selfLink": "A String", # The link to this cache instance. @@ -232,6 +235,7 @@

Method Details

"bucket": "A String", # The name of the bucket containing this cache instance. "createTime": "A String", # The creation time of the cache instance in RFC 3339 format. "id": "A String", # The ID of the resource, including the project number, bucket name and anywhere cache ID. + "ingestOnWrite": True or False, # Specifies whether objects are ingested into the cache upon write. "kind": "storage#anywhereCache", # The kind of item this is. For Anywhere Cache, this is always storage#anywhereCache. "pendingUpdate": True or False, # True if the cache instance has an active Update long-running operation. "selfLink": "A String", # The link to this cache instance. @@ -277,6 +281,7 @@

Method Details

"bucket": "A String", # The name of the bucket containing this cache instance. "createTime": "A String", # The creation time of the cache instance in RFC 3339 format. "id": "A String", # The ID of the resource, including the project number, bucket name and anywhere cache ID. + "ingestOnWrite": True or False, # Specifies whether objects are ingested into the cache upon write. "kind": "storage#anywhereCache", # The kind of item this is. For Anywhere Cache, this is always storage#anywhereCache. "pendingUpdate": True or False, # True if the cache instance has an active Update long-running operation. "selfLink": "A String", # The link to this cache instance. @@ -304,6 +309,7 @@

Method Details

"bucket": "A String", # The name of the bucket containing this cache instance. "createTime": "A String", # The creation time of the cache instance in RFC 3339 format. "id": "A String", # The ID of the resource, including the project number, bucket name and anywhere cache ID. + "ingestOnWrite": True or False, # Specifies whether objects are ingested into the cache upon write. "kind": "storage#anywhereCache", # The kind of item this is. For Anywhere Cache, this is always storage#anywhereCache. "pendingUpdate": True or False, # True if the cache instance has an active Update long-running operation. "selfLink": "A String", # The link to this cache instance. @@ -316,7 +322,7 @@

Method Details

update(bucket, anywhereCacheId, body=None) -
Updates the config(ttl and admissionPolicy) of an Anywhere Cache instance.
+  
Updates the config of an Anywhere Cache instance.
 
 Args:
   bucket: string, Name of the parent bucket. (required)
@@ -330,6 +336,7 @@ 

Method Details

"bucket": "A String", # The name of the bucket containing this cache instance. "createTime": "A String", # The creation time of the cache instance in RFC 3339 format. "id": "A String", # The ID of the resource, including the project number, bucket name and anywhere cache ID. + "ingestOnWrite": True or False, # Specifies whether objects are ingested into the cache upon write. "kind": "storage#anywhereCache", # The kind of item this is. For Anywhere Cache, this is always storage#anywhereCache. "pendingUpdate": True or False, # True if the cache instance has an active Update long-running operation. "selfLink": "A String", # The link to this cache instance. diff --git a/googleapiclient/discovery_cache/documents/storage.v1.json b/googleapiclient/discovery_cache/documents/storage.v1.json index 8446cd489e..f9603b7f5d 100644 --- a/googleapiclient/discovery_cache/documents/storage.v1.json +++ b/googleapiclient/discovery_cache/documents/storage.v1.json @@ -253,7 +253,7 @@ "location": "northamerica-south1" } ], -"etag": "\"31363539393037303230303637393438373935\"", +"etag": "\"3136383236333536383830353031333435373432\"", "icons": { "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png", "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png" @@ -521,7 +521,7 @@ ] }, "update": { -"description": "Updates the config(ttl and admissionPolicy) of an Anywhere Cache instance.", +"description": "Updates the config of an Anywhere Cache instance.", "httpMethod": "PATCH", "id": "storage.anywhereCaches.update", "parameterOrder": [ @@ -4605,7 +4605,7 @@ } } }, -"revision": "20260204", +"revision": "20260408", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AdvanceRelocateBucketOperationRequest": { @@ -4650,6 +4650,10 @@ "description": "The ID of the resource, including the project number, bucket name and anywhere cache ID.", "type": "string" }, +"ingestOnWrite": { +"description": "Specifies whether objects are ingested into the cache upon write.", +"type": "boolean" +}, "kind": { "default": "storage#anywhereCache", "description": "The kind of item this is. For Anywhere Cache, this is always storage#anywhereCache.", From eae19bf5ac78c204afbdac553f1580b5dfa462b6 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:41:01 +0000 Subject: [PATCH 29/32] feat(walletobjects): update the api #### walletobjects:v1 The following keys were added: - schemas.ContentTypeInfo.properties.fromFusionId.type (Total Keys: 1) - schemas.ContentTypeInfo.properties.fusionIdDetectionMetadata (Total Keys: 2) --- docs/dyn/walletobjects_v1.media.html | 4 ++++ .../discovery_cache/documents/walletobjects.v1.json | 11 ++++++++++- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/dyn/walletobjects_v1.media.html b/docs/dyn/walletobjects_v1.media.html index 408d6b1a4a..3c7e367eac 100644 --- a/docs/dyn/walletobjects_v1.media.html +++ b/docs/dyn/walletobjects_v1.media.html @@ -151,8 +151,10 @@

Method Details

"bestGuess": "A String", # Scotty's best guess of what the content type of the file is. "fromBytes": "A String", # The content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file. "fromFileName": "A String", # The content type of the file derived from the file extension of the original file name used by the client. + "fromFusionId": "A String", # The content type of the file detected by Fusion ID. go/fusionid "fromHeader": "A String", # The content type of the file as specified in the request headers, multipart headers, or RUPIO start request. "fromUrlPath": "A String", # The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API). + "fusionIdDetectionMetadata": "A String", # Metadata information from Fusion ID detection. Serialized FusionIdDetectionMetadata proto. Only set if from_fusion_id is set. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. "crc32cHash": 42, # For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported. @@ -421,8 +423,10 @@

Method Details

"bestGuess": "A String", # Scotty's best guess of what the content type of the file is. "fromBytes": "A String", # The content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file. "fromFileName": "A String", # The content type of the file derived from the file extension of the original file name used by the client. + "fromFusionId": "A String", # The content type of the file detected by Fusion ID. go/fusionid "fromHeader": "A String", # The content type of the file as specified in the request headers, multipart headers, or RUPIO start request. "fromUrlPath": "A String", # The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API). + "fusionIdDetectionMetadata": "A String", # Metadata information from Fusion ID detection. Serialized FusionIdDetectionMetadata proto. Only set if from_fusion_id is set. }, "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field. "crc32cHash": 42, # For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported. diff --git a/googleapiclient/discovery_cache/documents/walletobjects.v1.json b/googleapiclient/discovery_cache/documents/walletobjects.v1.json index ab7328fa22..7fd219ae38 100644 --- a/googleapiclient/discovery_cache/documents/walletobjects.v1.json +++ b/googleapiclient/discovery_cache/documents/walletobjects.v1.json @@ -2713,7 +2713,7 @@ } } }, -"revision": "20260327", +"revision": "20260408", "rootUrl": "https://walletobjects.googleapis.com/", "schemas": { "ActivationOptions": { @@ -3415,6 +3415,10 @@ true "description": "The content type of the file derived from the file extension of the original file name used by the client.", "type": "string" }, +"fromFusionId": { +"description": "The content type of the file detected by Fusion ID. go/fusionid", +"type": "string" +}, "fromHeader": { "description": "The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.", "type": "string" @@ -3422,6 +3426,11 @@ true "fromUrlPath": { "description": "The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).", "type": "string" +}, +"fusionIdDetectionMetadata": { +"description": "Metadata information from Fusion ID detection. Serialized FusionIdDetectionMetadata proto. Only set if from_fusion_id is set.", +"format": "byte", +"type": "string" } }, "type": "object" From e6c5196596e8c8aa31e0a894492a2095f2014287 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:41:02 +0000 Subject: [PATCH 30/32] feat(youtube): update the api #### youtube:v3 The following keys were deleted: - resources.activities.methods.list.parameters.mine.deprecated (Total Keys: 1) The following keys were added: - resources.activities.methods.list.parameters.home.deprecated (Total Keys: 1) --- googleapiclient/discovery_cache/documents/youtube.v3.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/youtube.v3.json b/googleapiclient/discovery_cache/documents/youtube.v3.json index 2f591a484c..e3a5177fac 100644 --- a/googleapiclient/discovery_cache/documents/youtube.v3.json +++ b/googleapiclient/discovery_cache/documents/youtube.v3.json @@ -172,6 +172,7 @@ "type": "string" }, "home": { +"deprecated": true, "location": "query", "type": "boolean" }, @@ -185,7 +186,6 @@ "type": "integer" }, "mine": { -"deprecated": true, "location": "query", "type": "boolean" }, @@ -4176,7 +4176,7 @@ } } }, -"revision": "20260323", +"revision": "20260412", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { From 111ee86cb911e57608680d54a72148fe198a1aa9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:41:02 +0000 Subject: [PATCH 31/32] feat(youtubereporting): update the api #### youtubereporting:v1 The following keys were added: - schemas.GdataContentTypeInfo.properties.fromFusionId.type (Total Keys: 1) - schemas.GdataContentTypeInfo.properties.fusionIdDetectionMetadata (Total Keys: 2) --- docs/dyn/youtubereporting_v1.media.html | 2 ++ .../documents/youtubereporting.v1.json | 11 ++++++++++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/dyn/youtubereporting_v1.media.html b/docs/dyn/youtubereporting_v1.media.html index 32684553f5..d63d3d9bdb 100644 --- a/docs/dyn/youtubereporting_v1.media.html +++ b/docs/dyn/youtubereporting_v1.media.html @@ -148,8 +148,10 @@

Method Details

"bestGuess": "A String", # gdata "fromBytes": "A String", # gdata "fromFileName": "A String", # gdata + "fromFusionId": "A String", # gdata "fromHeader": "A String", # gdata "fromUrlPath": "A String", # gdata + "fusionIdDetectionMetadata": "A String", # gdata }, "cosmoBinaryReference": "A String", # gdata "crc32cHash": 42, # gdata diff --git a/googleapiclient/discovery_cache/documents/youtubereporting.v1.json b/googleapiclient/discovery_cache/documents/youtubereporting.v1.json index 61949d043d..0453ad61e6 100644 --- a/googleapiclient/discovery_cache/documents/youtubereporting.v1.json +++ b/googleapiclient/discovery_cache/documents/youtubereporting.v1.json @@ -411,7 +411,7 @@ } } }, -"revision": "20260113", +"revision": "20260408", "rootUrl": "https://youtubereporting.googleapis.com/", "schemas": { "Empty": { @@ -549,6 +549,10 @@ "description": "gdata", "type": "string" }, +"fromFusionId": { +"description": "gdata", +"type": "string" +}, "fromHeader": { "description": "gdata", "type": "string" @@ -556,6 +560,11 @@ "fromUrlPath": { "description": "gdata", "type": "string" +}, +"fusionIdDetectionMetadata": { +"description": "gdata", +"format": "byte", +"type": "string" } }, "type": "object" From 62186de2416128544a4685a348b7f497ddacfbf5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Apr 2026 07:41:02 +0000 Subject: [PATCH 32/32] chore(docs): Add new discovery artifacts and artifacts with minor updates --- ...ects.locations.dataExchanges.listings.html | 2 +- docs/dyn/apihub_v1.projects.locations.html | 4 +- ...marketplace_v1.bidders.finalizedDeals.html | 2 +- ...smarketplace_v1.buyers.finalizedDeals.html | 2 +- ...tplace_v1alpha.bidders.finalizedDeals.html | 2 +- ...etplace_v1alpha.buyers.finalizedDeals.html | 2 +- ..._v1.projects.locations.appConnections.html | 26 ++--- ...p_v1.projects.locations.appConnectors.html | 10 +- .../dyn/beyondcorp_v1.projects.locations.html | 4 +- ...cations.securityGateways.applications.html | 2 +- ...1.projects.locations.securityGateways.html | 24 ++--- ...pha.projects.locations.appConnections.html | 26 ++--- ...lpha.projects.locations.appConnectors.html | 10 +- ...beyondcorp_v1alpha.projects.locations.html | 4 +- ...cations.securityGateways.applications.html | 2 +- ...a.projects.locations.securityGateways.html | 24 ++--- ...ons.transferConfigs.transferResources.html | 18 ++-- ...cts.transferConfigs.transferResources.html | 18 ++-- docs/dyn/classroom_v1.courses.html | 4 +- ...neage_v1.projects.locations.processes.html | 10 +- ..._v1.projects.locations.processes.runs.html | 10 +- ...ocations.processes.runs.lineageEvents.html | 6 +- docs/dyn/dns_v1.resourceRecordSets.html | 6 +- docs/dyn/dns_v1beta2.resourceRecordSets.html | 6 +- .../monitoring_v1.projects.dashboards.html | 96 +++++++++---------- ...nessinformation_v1.accounts.locations.html | 6 +- ...usinessinformation_v1.googleLocations.html | 4 +- ...inessbusinessinformation_v1.locations.html | 8 +- ...y_v1.projects.locations.authzPolicies.html | 16 ++-- ...eta1.projects.locations.authzPolicies.html | 16 ++-- docs/dyn/notebooks_v1.projects.locations.html | 4 +- docs/dyn/notebooks_v2.projects.locations.html | 4 +- ...dis_v1.projects.locations.aclPolicies.html | 6 +- ...s.locations.backupCollections.backups.html | 4 +- ....projects.locations.backupCollections.html | 2 +- .../redis_v1.projects.locations.clusters.html | 6 +- ...1beta1.projects.locations.aclPolicies.html | 6 +- ...s.locations.backupCollections.backups.html | 4 +- ....projects.locations.backupCollections.html | 2 +- ...s_v1beta1.projects.locations.clusters.html | 6 +- ...servicemanagement_v1.services.configs.html | 88 ++++++++--------- docs/dyn/servicemanagement_v1.services.html | 22 ++--- docs/dyn/serviceusage_v1.services.html | 6 +- docs/dyn/serviceusage_v1beta1.services.html | 4 +- docs/dyn/slides_v1.presentations.pages.html | 1 + ...projects.instances.databases.sessions.html | 32 +++---- ...workloadmanager_v1.projects.locations.html | 4 +- .../dyn/workspaceevents_v1.subscriptions.html | 28 +++--- ...rojects.locations.workstationClusters.html | 8 ++ .../documents/alertcenter.v1beta1.json | 8 +- .../documents/analyticshub.v1.json | 4 +- .../documents/androidmanagement.v1.json | 4 +- .../discovery_cache/documents/apihub.v1.json | 4 +- .../authorizedbuyersmarketplace.v1.json | 6 +- .../authorizedbuyersmarketplace.v1alpha.json | 6 +- .../documents/beyondcorp.v1.json | 24 ++--- .../documents/beyondcorp.v1alpha.json | 24 ++--- .../documents/bigquerydatatransfer.v1.json | 16 ++-- .../documents/classroom.v1.json | 6 +- .../documents/datalineage.v1.json | 28 +++--- .../discovery_cache/documents/dns.v1.json | 8 +- .../documents/dns.v1beta2.json | 8 +- .../documents/firebaseml.v2beta.json | 8 +- .../documents/monitoring.v1.json | 6 +- .../mybusinessbusinessinformation.v1.json | 6 +- .../documents/networksecurity.v1.json | 6 +- .../documents/networksecurity.v1beta1.json | 6 +- .../documents/notebooks.v1.json | 4 +- .../documents/notebooks.v2.json | 28 ++++-- .../documents/recaptchaenterprise.v1.json | 10 +- .../discovery_cache/documents/redis.v1.json | 50 ++++++---- .../documents/redis.v1beta1.json | 50 ++++++---- .../serviceconsumermanagement.v1.json | 12 +-- .../serviceconsumermanagement.v1beta1.json | 12 +-- .../documents/servicemanagement.v1.json | 12 +-- .../documents/servicenetworking.v1.json | 18 ++-- .../documents/servicenetworking.v1beta.json | 18 ++-- .../documents/serviceusage.v1.json | 12 +-- .../documents/serviceusage.v1beta1.json | 12 +-- .../discovery_cache/documents/slides.v1.json | 8 +- .../discovery_cache/documents/spanner.v1.json | 4 +- .../documents/workloadmanager.v1.json | 4 +- .../documents/workspaceevents.v1.json | 16 ++-- .../documents/workstations.v1.json | 10 +- 84 files changed, 574 insertions(+), 491 deletions(-) diff --git a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html index 6e6633e91e..27816da445 100644 --- a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html +++ b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html @@ -1004,7 +1004,7 @@

Method Details

"maximumBackoff": "A String", # Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds. "minimumBackoff": "A String", # Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. }, - "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" See https://{$universe.dns_names.final_documentation_domain}/pubsub/docs/tags for more information on using tags with Pub/Sub resources. "a_key": "A String", }, }, diff --git a/docs/dyn/apihub_v1.projects.locations.html b/docs/dyn/apihub_v1.projects.locations.html index 624a9465cc..ac416a8623 100644 --- a/docs/dyn/apihub_v1.projects.locations.html +++ b/docs/dyn/apihub_v1.projects.locations.html @@ -150,7 +150,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.

@@ -1057,7 +1057,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/authorizedbuyersmarketplace_v1.bidders.finalizedDeals.html b/docs/dyn/authorizedbuyersmarketplace_v1.bidders.finalizedDeals.html
index 20cdf59c7c..679c4e0f2e 100644
--- a/docs/dyn/authorizedbuyersmarketplace_v1.bidders.finalizedDeals.html
+++ b/docs/dyn/authorizedbuyersmarketplace_v1.bidders.finalizedDeals.html
@@ -98,7 +98,7 @@ 

Method Details

Args: parent: string, Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`. (required) - filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus + filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus * readyToServe orderBy: string, An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth pageSize: integer, Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100. pageToken: string, The page token as returned from ListFinalizedDealsResponse. diff --git a/docs/dyn/authorizedbuyersmarketplace_v1.buyers.finalizedDeals.html b/docs/dyn/authorizedbuyersmarketplace_v1.buyers.finalizedDeals.html index f55059707c..83ab44e89c 100644 --- a/docs/dyn/authorizedbuyersmarketplace_v1.buyers.finalizedDeals.html +++ b/docs/dyn/authorizedbuyersmarketplace_v1.buyers.finalizedDeals.html @@ -639,7 +639,7 @@

Method Details

Args: parent: string, Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`. (required) - filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus + filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus * readyToServe orderBy: string, An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth pageSize: integer, Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100. pageToken: string, The page token as returned from ListFinalizedDealsResponse. diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.finalizedDeals.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.finalizedDeals.html index e3c3a85da6..58bac7f193 100644 --- a/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.finalizedDeals.html +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.finalizedDeals.html @@ -98,7 +98,7 @@

Method Details

Args: parent: string, Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`. (required) - filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus + filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus * readyToServe orderBy: string, An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth pageSize: integer, Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100. pageToken: string, The page token as returned from ListFinalizedDealsResponse. diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.finalizedDeals.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.finalizedDeals.html index 2c0ad72298..ea66515431 100644 --- a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.finalizedDeals.html +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.finalizedDeals.html @@ -639,7 +639,7 @@

Method Details

Args: parent: string, Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`. (required) - filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus + filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus * readyToServe orderBy: string, An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth pageSize: integer, Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100. pageToken: string, The page token as returned from ListFinalizedDealsResponse. diff --git a/docs/dyn/beyondcorp_v1.projects.locations.appConnections.html b/docs/dyn/beyondcorp_v1.projects.locations.appConnections.html index 656aafc48c..f2eb0c3312 100644 --- a/docs/dyn/beyondcorp_v1.projects.locations.appConnections.html +++ b/docs/dyn/beyondcorp_v1.projects.locations.appConnections.html @@ -125,12 +125,12 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorised for a single AppConnection. +{ # A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorized for a single AppConnection. "applicationEndpoint": { # ApplicationEndpoint represents a remote application endpoint. # Required. Address of the remote application endpoint for the BeyondCorp AppConnection. "host": "A String", # Required. Hostname or IP address of the remote application endpoint. "port": 42, # Required. Port of the remote application endpoint. }, - "connectors": [ # Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection. + "connectors": [ # Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorized to be associated with this AppConnection. "A String", ], "createTime": "A String", # Output only. Timestamp when the resource was created. @@ -155,7 +155,7 @@

Method Details

} appConnectionId: string, Optional. User-settable AppConnection resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or a letter. - 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 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). + 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 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, 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: boolean, Optional. If set, validates request by executing a dry-run which would not alter the resource in any way. x__xgafv: string, V1 error format. Allowed values @@ -192,7 +192,7 @@

Method Details

Args: name: string, Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}` (required) - 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). + 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 the 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: boolean, Optional. If set, validates request by executing a dry-run which would not alter the resource in any way. x__xgafv: string, V1 error format. Allowed values @@ -237,12 +237,12 @@

Method Details

Returns: An object of the form: - { # A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorised for a single AppConnection. + { # A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorized for a single AppConnection. "applicationEndpoint": { # ApplicationEndpoint represents a remote application endpoint. # Required. Address of the remote application endpoint for the BeyondCorp AppConnection. "host": "A String", # Required. Hostname or IP address of the remote application endpoint. "port": 42, # Required. Port of the remote application endpoint. }, - "connectors": [ # Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection. + "connectors": [ # Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorized to be associated with this AppConnection. "A String", ], "createTime": "A String", # Output only. Timestamp when the resource was created. @@ -335,12 +335,12 @@

Method Details

{ # Response message for BeyondCorp.ListAppConnections. "appConnections": [ # A list of BeyondCorp AppConnections in the project. - { # A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorised for a single AppConnection. + { # A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorized for a single AppConnection. "applicationEndpoint": { # ApplicationEndpoint represents a remote application endpoint. # Required. Address of the remote application endpoint for the BeyondCorp AppConnection. "host": "A String", # Required. Hostname or IP address of the remote application endpoint. "port": 42, # Required. Port of the remote application endpoint. }, - "connectors": [ # Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection. + "connectors": [ # Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorized to be associated with this AppConnection. "A String", ], "createTime": "A String", # Output only. Timestamp when the resource was created. @@ -394,12 +394,12 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorised for a single AppConnection. +{ # A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorized for a single AppConnection. "applicationEndpoint": { # ApplicationEndpoint represents a remote application endpoint. # Required. Address of the remote application endpoint for the BeyondCorp AppConnection. "host": "A String", # Required. Hostname or IP address of the remote application endpoint. "port": 42, # Required. Port of the remote application endpoint. }, - "connectors": [ # Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection. + "connectors": [ # Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorized to be associated with this AppConnection. "A String", ], "createTime": "A String", # Output only. Timestamp when the resource was created. @@ -424,7 +424,7 @@

Method Details

} allowMissing: boolean, Optional. If set as true, will create the resource if it is not found. - 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 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). + 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 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, 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, Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [BeyondCorp.AppConnection]: * `labels` * `display_name` * `application_endpoint` * `connectors` validateOnly: boolean, Optional. If set, validates request by executing a dry-run which would not alter the resource in any way. x__xgafv: string, V1 error format. @@ -476,12 +476,12 @@

Method Details

{ # Response message for BeyondCorp.ResolveAppConnections. "appConnectionDetails": [ # A list of BeyondCorp AppConnections with details in the project. { # Details of the AppConnection. - "appConnection": { # A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorised for a single AppConnection. # A BeyondCorp AppConnection in the project. + "appConnection": { # A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorized for a single AppConnection. # A BeyondCorp AppConnection in the project. "applicationEndpoint": { # ApplicationEndpoint represents a remote application endpoint. # Required. Address of the remote application endpoint for the BeyondCorp AppConnection. "host": "A String", # Required. Hostname or IP address of the remote application endpoint. "port": 42, # Required. Port of the remote application endpoint. }, - "connectors": [ # Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection. + "connectors": [ # Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorized to be associated with this AppConnection. "A String", ], "createTime": "A String", # Output only. Timestamp when the resource was created. diff --git a/docs/dyn/beyondcorp_v1.projects.locations.appConnectors.html b/docs/dyn/beyondcorp_v1.projects.locations.appConnectors.html index 12747d5af1..81748e316e 100644 --- a/docs/dyn/beyondcorp_v1.projects.locations.appConnectors.html +++ b/docs/dyn/beyondcorp_v1.projects.locations.appConnectors.html @@ -137,7 +137,7 @@

Method Details

"email": "A String", # Email address of the service account. }, }, - "resourceInfo": { # ResourceInfo represents the information/status of an app connector resource. Such as: - remote_agent - container - runtime - appgateway - appconnector - appconnection - tunnel - logagent # Optional. Resource info of the connector. + "resourceInfo": { # ResourceInfo represents the information or status of an app connector resource component that's used to report on various parts of the system. For example, ResourceInfo can be used to convey the status of a remote_agent, including the status of an appgateway for an runtime environment in a container instance. # Optional. Resource info of the connector. "id": "A String", # Required. Unique Id for the resource. "resource": { # Specific details for the resource. This is for internal use only. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -248,7 +248,7 @@

Method Details

"email": "A String", # Email address of the service account. }, }, - "resourceInfo": { # ResourceInfo represents the information/status of an app connector resource. Such as: - remote_agent - container - runtime - appgateway - appconnector - appconnection - tunnel - logagent # Optional. Resource info of the connector. + "resourceInfo": { # ResourceInfo represents the information or status of an app connector resource component that's used to report on various parts of the system. For example, ResourceInfo can be used to convey the status of a remote_agent, including the status of an appgateway for an runtime environment in a container instance. # Optional. Resource info of the connector. "id": "A String", # Required. Unique Id for the resource. "resource": { # Specific details for the resource. This is for internal use only. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -345,7 +345,7 @@

Method Details

"email": "A String", # Email address of the service account. }, }, - "resourceInfo": { # ResourceInfo represents the information/status of an app connector resource. Such as: - remote_agent - container - runtime - appgateway - appconnector - appconnection - tunnel - logagent # Optional. Resource info of the connector. + "resourceInfo": { # ResourceInfo represents the information or status of an app connector resource component that's used to report on various parts of the system. For example, ResourceInfo can be used to convey the status of a remote_agent, including the status of an appgateway for an runtime environment in a container instance. # Optional. Resource info of the connector. "id": "A String", # Required. Unique Id for the resource. "resource": { # Specific details for the resource. This is for internal use only. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -403,7 +403,7 @@

Method Details

"email": "A String", # Email address of the service account. }, }, - "resourceInfo": { # ResourceInfo represents the information/status of an app connector resource. Such as: - remote_agent - container - runtime - appgateway - appconnector - appconnection - tunnel - logagent # Optional. Resource info of the connector. + "resourceInfo": { # ResourceInfo represents the information or status of an app connector resource component that's used to report on various parts of the system. For example, ResourceInfo can be used to convey the status of a remote_agent, including the status of an appgateway for an runtime environment in a container instance. # Optional. Resource info of the connector. "id": "A String", # Required. Unique Id for the resource. "resource": { # Specific details for the resource. This is for internal use only. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -462,7 +462,7 @@

Method Details

{ # Request report the connector status. "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 will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - "resourceInfo": { # ResourceInfo represents the information/status of an app connector resource. Such as: - remote_agent - container - runtime - appgateway - appconnector - appconnection - tunnel - logagent # Required. Resource info of the connector. + "resourceInfo": { # ResourceInfo represents the information or status of an app connector resource component that's used to report on various parts of the system. For example, ResourceInfo can be used to convey the status of a remote_agent, including the status of an appgateway for an runtime environment in a container instance. # Required. Resource info of the connector. "id": "A String", # Required. Unique Id for the resource. "resource": { # Specific details for the resource. This is for internal use only. "a_key": "", # Properties of the object. Contains field @type with type URL. diff --git a/docs/dyn/beyondcorp_v1.projects.locations.html b/docs/dyn/beyondcorp_v1.projects.locations.html index 1ce8996e7a..1372e6fa1d 100644 --- a/docs/dyn/beyondcorp_v1.projects.locations.html +++ b/docs/dyn/beyondcorp_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/beyondcorp_v1.projects.locations.securityGateways.applications.html b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.applications.html
index f4a4485588..04e9efce71 100644
--- a/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.applications.html
+++ b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.applications.html
@@ -178,7 +178,7 @@ 

Method Details

} applicationId: string, Optional. User-settable Application resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter. - 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 request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. + 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 since the first request. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html index 7f424bcdaa..e9f5ffb13b 100644 --- a/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html +++ b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.html @@ -166,9 +166,9 @@

Method Details

}, }, "serviceDiscovery": { # Settings related to the Service Discovery. # Optional. Settings related to the Service Discovery. - "apiGateway": { # If Service Discovery is done through API, defines its settings. # Required. External API configuration. - "resourceOverride": { # API operation descriptor. # Required. Enables fetching resource model updates to alter service behavior per Chrome profile. - "path": "A String", # Required. Contains the URI path fragment where HTTP request is sent. + "apiGateway": { # If Service Discovery is done through API, defines its settings. # Optional. External API configuration. + "resourceOverride": { # API operation descriptor. # Optional. Enables fetching resource model updates to alter service behavior per Chrome profile. + "path": "A String", # Optional. Contains the URI path fragment where HTTP request is sent. }, }, }, @@ -300,9 +300,9 @@

Method Details

}, }, "serviceDiscovery": { # Settings related to the Service Discovery. # Optional. Settings related to the Service Discovery. - "apiGateway": { # If Service Discovery is done through API, defines its settings. # Required. External API configuration. - "resourceOverride": { # API operation descriptor. # Required. Enables fetching resource model updates to alter service behavior per Chrome profile. - "path": "A String", # Required. Contains the URI path fragment where HTTP request is sent. + "apiGateway": { # If Service Discovery is done through API, defines its settings. # Optional. External API configuration. + "resourceOverride": { # API operation descriptor. # Optional. Enables fetching resource model updates to alter service behavior per Chrome profile. + "path": "A String", # Optional. Contains the URI path fragment where HTTP request is sent. }, }, }, @@ -422,9 +422,9 @@

Method Details

}, }, "serviceDiscovery": { # Settings related to the Service Discovery. # Optional. Settings related to the Service Discovery. - "apiGateway": { # If Service Discovery is done through API, defines its settings. # Required. External API configuration. - "resourceOverride": { # API operation descriptor. # Required. Enables fetching resource model updates to alter service behavior per Chrome profile. - "path": "A String", # Required. Contains the URI path fragment where HTTP request is sent. + "apiGateway": { # If Service Discovery is done through API, defines its settings. # Optional. External API configuration. + "resourceOverride": { # API operation descriptor. # Optional. Enables fetching resource model updates to alter service behavior per Chrome profile. + "path": "A String", # Optional. Contains the URI path fragment where HTTP request is sent. }, }, }, @@ -503,9 +503,9 @@

Method Details

}, }, "serviceDiscovery": { # Settings related to the Service Discovery. # Optional. Settings related to the Service Discovery. - "apiGateway": { # If Service Discovery is done through API, defines its settings. # Required. External API configuration. - "resourceOverride": { # API operation descriptor. # Required. Enables fetching resource model updates to alter service behavior per Chrome profile. - "path": "A String", # Required. Contains the URI path fragment where HTTP request is sent. + "apiGateway": { # If Service Discovery is done through API, defines its settings. # Optional. External API configuration. + "resourceOverride": { # API operation descriptor. # Optional. Enables fetching resource model updates to alter service behavior per Chrome profile. + "path": "A String", # Optional. Contains the URI path fragment where HTTP request is sent. }, }, }, diff --git a/docs/dyn/beyondcorp_v1alpha.projects.locations.appConnections.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.appConnections.html index 1741223a20..f9d1385f2d 100644 --- a/docs/dyn/beyondcorp_v1alpha.projects.locations.appConnections.html +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.appConnections.html @@ -125,12 +125,12 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorised for a single AppConnection. +{ # A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorized for a single AppConnection. "applicationEndpoint": { # ApplicationEndpoint represents a remote application endpoint. # Required. Address of the remote application endpoint for the BeyondCorp AppConnection. "host": "A String", # Required. Hostname or IP address of the remote application endpoint. "port": 42, # Required. Port of the remote application endpoint. }, - "connectors": [ # Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection. + "connectors": [ # Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorized to be associated with this AppConnection. "A String", ], "createTime": "A String", # Output only. Timestamp when the resource was created. @@ -155,7 +155,7 @@

Method Details

} appConnectionId: string, Optional. User-settable AppConnection resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or a letter. - 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 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). + 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 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, 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: boolean, Optional. If set, validates request by executing a dry-run which would not alter the resource in any way. x__xgafv: string, V1 error format. Allowed values @@ -192,7 +192,7 @@

Method Details

Args: name: string, Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}` (required) - 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). + 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 the 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: boolean, Optional. If set, validates request by executing a dry-run which would not alter the resource in any way. x__xgafv: string, V1 error format. Allowed values @@ -237,12 +237,12 @@

Method Details

Returns: An object of the form: - { # A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorised for a single AppConnection. + { # A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorized for a single AppConnection. "applicationEndpoint": { # ApplicationEndpoint represents a remote application endpoint. # Required. Address of the remote application endpoint for the BeyondCorp AppConnection. "host": "A String", # Required. Hostname or IP address of the remote application endpoint. "port": 42, # Required. Port of the remote application endpoint. }, - "connectors": [ # Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection. + "connectors": [ # Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorized to be associated with this AppConnection. "A String", ], "createTime": "A String", # Output only. Timestamp when the resource was created. @@ -335,12 +335,12 @@

Method Details

{ # Response message for BeyondCorp.ListAppConnections. "appConnections": [ # A list of BeyondCorp AppConnections in the project. - { # A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorised for a single AppConnection. + { # A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorized for a single AppConnection. "applicationEndpoint": { # ApplicationEndpoint represents a remote application endpoint. # Required. Address of the remote application endpoint for the BeyondCorp AppConnection. "host": "A String", # Required. Hostname or IP address of the remote application endpoint. "port": 42, # Required. Port of the remote application endpoint. }, - "connectors": [ # Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection. + "connectors": [ # Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorized to be associated with this AppConnection. "A String", ], "createTime": "A String", # Output only. Timestamp when the resource was created. @@ -394,12 +394,12 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorised for a single AppConnection. +{ # A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorized for a single AppConnection. "applicationEndpoint": { # ApplicationEndpoint represents a remote application endpoint. # Required. Address of the remote application endpoint for the BeyondCorp AppConnection. "host": "A String", # Required. Hostname or IP address of the remote application endpoint. "port": 42, # Required. Port of the remote application endpoint. }, - "connectors": [ # Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection. + "connectors": [ # Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorized to be associated with this AppConnection. "A String", ], "createTime": "A String", # Output only. Timestamp when the resource was created. @@ -424,7 +424,7 @@

Method Details

} allowMissing: boolean, Optional. If set as true, will create the resource if it is not found. - 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 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). + 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 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, 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, Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [BeyondCorp.AppConnection]: * `labels` * `display_name` * `application_endpoint` * `connectors` validateOnly: boolean, Optional. If set, validates request by executing a dry-run which would not alter the resource in any way. x__xgafv: string, V1 error format. @@ -476,12 +476,12 @@

Method Details

{ # Response message for BeyondCorp.ResolveAppConnections. "appConnectionDetails": [ # A list of BeyondCorp AppConnections with details in the project. { # Details of the AppConnection. - "appConnection": { # A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorised for a single AppConnection. # A BeyondCorp AppConnection in the project. + "appConnection": { # A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorized for a single AppConnection. # A BeyondCorp AppConnection in the project. "applicationEndpoint": { # ApplicationEndpoint represents a remote application endpoint. # Required. Address of the remote application endpoint for the BeyondCorp AppConnection. "host": "A String", # Required. Hostname or IP address of the remote application endpoint. "port": 42, # Required. Port of the remote application endpoint. }, - "connectors": [ # Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection. + "connectors": [ # Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorized to be associated with this AppConnection. "A String", ], "createTime": "A String", # Output only. Timestamp when the resource was created. diff --git a/docs/dyn/beyondcorp_v1alpha.projects.locations.appConnectors.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.appConnectors.html index e1d0cefc6a..0801b58a9c 100644 --- a/docs/dyn/beyondcorp_v1alpha.projects.locations.appConnectors.html +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.appConnectors.html @@ -137,7 +137,7 @@

Method Details

"email": "A String", # Email address of the service account. }, }, - "resourceInfo": { # ResourceInfo represents the information/status of an app connector resource. Such as: - remote_agent - container - runtime - appgateway - appconnector - appconnection - tunnel - logagent # Optional. Resource info of the connector. + "resourceInfo": { # ResourceInfo represents the information or status of an app connector resource component that's used to report on various parts of the system. For example, ResourceInfo can be used to convey the status of a remote_agent, including the status of an appgateway for an runtime environment in a container instance. # Optional. Resource info of the connector. "id": "A String", # Required. Unique Id for the resource. "resource": { # Specific details for the resource. This is for internal use only. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -248,7 +248,7 @@

Method Details

"email": "A String", # Email address of the service account. }, }, - "resourceInfo": { # ResourceInfo represents the information/status of an app connector resource. Such as: - remote_agent - container - runtime - appgateway - appconnector - appconnection - tunnel - logagent # Optional. Resource info of the connector. + "resourceInfo": { # ResourceInfo represents the information or status of an app connector resource component that's used to report on various parts of the system. For example, ResourceInfo can be used to convey the status of a remote_agent, including the status of an appgateway for an runtime environment in a container instance. # Optional. Resource info of the connector. "id": "A String", # Required. Unique Id for the resource. "resource": { # Specific details for the resource. This is for internal use only. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -345,7 +345,7 @@

Method Details

"email": "A String", # Email address of the service account. }, }, - "resourceInfo": { # ResourceInfo represents the information/status of an app connector resource. Such as: - remote_agent - container - runtime - appgateway - appconnector - appconnection - tunnel - logagent # Optional. Resource info of the connector. + "resourceInfo": { # ResourceInfo represents the information or status of an app connector resource component that's used to report on various parts of the system. For example, ResourceInfo can be used to convey the status of a remote_agent, including the status of an appgateway for an runtime environment in a container instance. # Optional. Resource info of the connector. "id": "A String", # Required. Unique Id for the resource. "resource": { # Specific details for the resource. This is for internal use only. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -403,7 +403,7 @@

Method Details

"email": "A String", # Email address of the service account. }, }, - "resourceInfo": { # ResourceInfo represents the information/status of an app connector resource. Such as: - remote_agent - container - runtime - appgateway - appconnector - appconnection - tunnel - logagent # Optional. Resource info of the connector. + "resourceInfo": { # ResourceInfo represents the information or status of an app connector resource component that's used to report on various parts of the system. For example, ResourceInfo can be used to convey the status of a remote_agent, including the status of an appgateway for an runtime environment in a container instance. # Optional. Resource info of the connector. "id": "A String", # Required. Unique Id for the resource. "resource": { # Specific details for the resource. This is for internal use only. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -462,7 +462,7 @@

Method Details

{ # Request report the connector status. "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 will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - "resourceInfo": { # ResourceInfo represents the information/status of an app connector resource. Such as: - remote_agent - container - runtime - appgateway - appconnector - appconnection - tunnel - logagent # Required. Resource info of the connector. + "resourceInfo": { # ResourceInfo represents the information or status of an app connector resource component that's used to report on various parts of the system. For example, ResourceInfo can be used to convey the status of a remote_agent, including the status of an appgateway for an runtime environment in a container instance. # Required. Resource info of the connector. "id": "A String", # Required. Unique Id for the resource. "resource": { # Specific details for the resource. This is for internal use only. "a_key": "", # Properties of the object. Contains field @type with type URL. diff --git a/docs/dyn/beyondcorp_v1alpha.projects.locations.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.html index 4d82ded36f..5338d20d10 100644 --- a/docs/dyn/beyondcorp_v1alpha.projects.locations.html +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.html @@ -132,7 +132,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.

@@ -171,7 +171,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/beyondcorp_v1alpha.projects.locations.securityGateways.applications.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.applications.html
index 4253243101..74ae0bde2a 100644
--- a/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.applications.html
+++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.applications.html
@@ -178,7 +178,7 @@ 

Method Details

} applicationId: string, Optional. User-settable Application resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter. - 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 request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. + 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 since the first request. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html index 4cd1aea3d2..002e7bdef6 100644 --- a/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html @@ -166,9 +166,9 @@

Method Details

}, }, "serviceDiscovery": { # Settings related to the Service Discovery. # Optional. Settings related to the Service Discovery. - "apiGateway": { # If Service Discovery is done through API, defines its settings. # Required. External API configuration. - "resourceOverride": { # API operation descriptor. # Required. Enables fetching resource model updates to alter service behavior per Chrome profile. - "path": "A String", # Required. Contains the URI path fragment where HTTP request is sent. + "apiGateway": { # If Service Discovery is done through API, defines its settings. # Optional. External API configuration. + "resourceOverride": { # API operation descriptor. # Optional. Enables fetching resource model updates to alter service behavior per Chrome profile. + "path": "A String", # Optional. Contains the URI path fragment where HTTP request is sent. }, }, }, @@ -300,9 +300,9 @@

Method Details

}, }, "serviceDiscovery": { # Settings related to the Service Discovery. # Optional. Settings related to the Service Discovery. - "apiGateway": { # If Service Discovery is done through API, defines its settings. # Required. External API configuration. - "resourceOverride": { # API operation descriptor. # Required. Enables fetching resource model updates to alter service behavior per Chrome profile. - "path": "A String", # Required. Contains the URI path fragment where HTTP request is sent. + "apiGateway": { # If Service Discovery is done through API, defines its settings. # Optional. External API configuration. + "resourceOverride": { # API operation descriptor. # Optional. Enables fetching resource model updates to alter service behavior per Chrome profile. + "path": "A String", # Optional. Contains the URI path fragment where HTTP request is sent. }, }, }, @@ -422,9 +422,9 @@

Method Details

}, }, "serviceDiscovery": { # Settings related to the Service Discovery. # Optional. Settings related to the Service Discovery. - "apiGateway": { # If Service Discovery is done through API, defines its settings. # Required. External API configuration. - "resourceOverride": { # API operation descriptor. # Required. Enables fetching resource model updates to alter service behavior per Chrome profile. - "path": "A String", # Required. Contains the URI path fragment where HTTP request is sent. + "apiGateway": { # If Service Discovery is done through API, defines its settings. # Optional. External API configuration. + "resourceOverride": { # API operation descriptor. # Optional. Enables fetching resource model updates to alter service behavior per Chrome profile. + "path": "A String", # Optional. Contains the URI path fragment where HTTP request is sent. }, }, }, @@ -503,9 +503,9 @@

Method Details

}, }, "serviceDiscovery": { # Settings related to the Service Discovery. # Optional. Settings related to the Service Discovery. - "apiGateway": { # If Service Discovery is done through API, defines its settings. # Required. External API configuration. - "resourceOverride": { # API operation descriptor. # Required. Enables fetching resource model updates to alter service behavior per Chrome profile. - "path": "A String", # Required. Contains the URI path fragment where HTTP request is sent. + "apiGateway": { # If Service Discovery is done through API, defines its settings. # Optional. External API configuration. + "resourceOverride": { # API operation descriptor. # Optional. Enables fetching resource model updates to alter service behavior per Chrome profile. + "path": "A String", # Optional. Contains the URI path fragment where HTTP request is sent. }, }, }, diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.transferResources.html b/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.transferResources.html index cad3588c6c..86ceeebffa 100644 --- a/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.transferResources.html +++ b/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.transferResources.html @@ -106,7 +106,7 @@

Method Details

Returns: An object of the form: - { # Resource(table/partition) that is being transferred. + { # Resource (table/partition) that is being transferred. "destination": "A String", # Optional. Resource destination. "hierarchyDetail": { # Details about the hierarchy. # Optional. Details about the hierarchy. "partitionDetail": { # Partition details related to hierarchy. # Optional. Partition details related to hierarchy. @@ -117,11 +117,11 @@

Method Details

}, }, "lastSuccessfulRun": { # Basic information about a transfer run. # Output only. Run details for the last successful run. - "run": "A String", # Optional. Run URI. Format projects/{project}/locations/{location}/transferConfigs/{config}/run/{run} + "run": "A String", # Optional. Run URI. The format must be: `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/run/{run}` "startTime": "A String", # Optional. Start time of the transfer run. }, "latestRun": { # Basic information about a transfer run. # Optional. Run details for the latest run. - "run": "A String", # Optional. Run URI. Format projects/{project}/locations/{location}/transferConfigs/{config}/run/{run} + "run": "A String", # Optional. Run URI. The format must be: `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/run/{run}` "startTime": "A String", # Optional. Start time of the transfer run. }, "latestStatusDetail": { # Status details of the resource being transferred. # Optional. Status details for the latest run. @@ -160,8 +160,8 @@

Method Details

Returns information about transfer resources.
 
 Args:
-  parent: string, Required. Name of transfer configuration for which transfer resources should be retrieved. The name should be in one of the following form: * `projects/{project_id}/transferConfigs/{config_id}` * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` (required)
-  filter: string, Optional. Filter for the transfer resources. Currently supported filters include: * Resource name: `name` - Wildcard supported * Resource type: `type` * Resource destination: `destination` * Latest resource state: `latest_status_detail.state` * Last update time: `update_time` - RFC-3339 format * Parent table name: `hierarchy_detail.partition_detail.table` Multiple filters can be applied using the `AND/OR` operator. Examples: * `name="*123" AND (type="TABLE" OR latest_status_detail.state="SUCCEEDED")` * `update_time >= "2012-04-21T11:30:00-04:00` * `hierarchy_detail.partition_detail.table = "table1"`
+  parent: string, Required. Name of transfer configuration for which transfer resources should be retrieved. The name should be in one of the following forms: * `projects/{project}/transferConfigs/{transfer_config}` * `projects/{project}/locations/{location_id}/transferConfigs/{transfer_config}` (required)
+  filter: string, Optional. Filter for the transfer resources. Currently supported filters include: * Resource name: `name` - Wildcard supported * Resource type: `type` * Resource destination: `destination` * Latest resource state: `latest_status_detail.state` * Last update time: `update_time` - RFC-3339 format * Parent table name: `hierarchy_detail.partition_detail.table` Multiple filters can be applied using the `AND/OR` operator. Examples: * `name="*123" AND (type="TABLE" OR latest_status_detail.state="SUCCEEDED")` * `update_time >= "2012-04-21T11:30:00-04:00"` * `hierarchy_detail.partition_detail.table = "table1"`
   pageSize: integer, Optional. The maximum number of transfer resources to return. The maximum value is 1000; values above 1000 will be coerced to 1000. The default page size is the maximum value of 1000 results.
   pageToken: string, Optional. A page token, received from a previous `ListTransferResources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTransferResources` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
@@ -172,10 +172,10 @@ 

Method Details

Returns: An object of the form: - { # Response for the ListTransferResources RPC. + { # Response for the `ListTransferResources` RPC. "nextPageToken": "A String", # Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "transferResources": [ # Output only. The transfer resources. - { # Resource(table/partition) that is being transferred. + { # Resource (table/partition) that is being transferred. "destination": "A String", # Optional. Resource destination. "hierarchyDetail": { # Details about the hierarchy. # Optional. Details about the hierarchy. "partitionDetail": { # Partition details related to hierarchy. # Optional. Partition details related to hierarchy. @@ -186,11 +186,11 @@

Method Details

}, }, "lastSuccessfulRun": { # Basic information about a transfer run. # Output only. Run details for the last successful run. - "run": "A String", # Optional. Run URI. Format projects/{project}/locations/{location}/transferConfigs/{config}/run/{run} + "run": "A String", # Optional. Run URI. The format must be: `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/run/{run}` "startTime": "A String", # Optional. Start time of the transfer run. }, "latestRun": { # Basic information about a transfer run. # Optional. Run details for the latest run. - "run": "A String", # Optional. Run URI. Format projects/{project}/locations/{location}/transferConfigs/{config}/run/{run} + "run": "A String", # Optional. Run URI. The format must be: `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/run/{run}` "startTime": "A String", # Optional. Start time of the transfer run. }, "latestStatusDetail": { # Status details of the resource being transferred. # Optional. Status details for the latest run. diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.transferResources.html b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.transferResources.html index 8a4f108040..189f672b23 100644 --- a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.transferResources.html +++ b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.transferResources.html @@ -106,7 +106,7 @@

Method Details

Returns: An object of the form: - { # Resource(table/partition) that is being transferred. + { # Resource (table/partition) that is being transferred. "destination": "A String", # Optional. Resource destination. "hierarchyDetail": { # Details about the hierarchy. # Optional. Details about the hierarchy. "partitionDetail": { # Partition details related to hierarchy. # Optional. Partition details related to hierarchy. @@ -117,11 +117,11 @@

Method Details

}, }, "lastSuccessfulRun": { # Basic information about a transfer run. # Output only. Run details for the last successful run. - "run": "A String", # Optional. Run URI. Format projects/{project}/locations/{location}/transferConfigs/{config}/run/{run} + "run": "A String", # Optional. Run URI. The format must be: `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/run/{run}` "startTime": "A String", # Optional. Start time of the transfer run. }, "latestRun": { # Basic information about a transfer run. # Optional. Run details for the latest run. - "run": "A String", # Optional. Run URI. Format projects/{project}/locations/{location}/transferConfigs/{config}/run/{run} + "run": "A String", # Optional. Run URI. The format must be: `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/run/{run}` "startTime": "A String", # Optional. Start time of the transfer run. }, "latestStatusDetail": { # Status details of the resource being transferred. # Optional. Status details for the latest run. @@ -160,8 +160,8 @@

Method Details

Returns information about transfer resources.
 
 Args:
-  parent: string, Required. Name of transfer configuration for which transfer resources should be retrieved. The name should be in one of the following form: * `projects/{project_id}/transferConfigs/{config_id}` * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` (required)
-  filter: string, Optional. Filter for the transfer resources. Currently supported filters include: * Resource name: `name` - Wildcard supported * Resource type: `type` * Resource destination: `destination` * Latest resource state: `latest_status_detail.state` * Last update time: `update_time` - RFC-3339 format * Parent table name: `hierarchy_detail.partition_detail.table` Multiple filters can be applied using the `AND/OR` operator. Examples: * `name="*123" AND (type="TABLE" OR latest_status_detail.state="SUCCEEDED")` * `update_time >= "2012-04-21T11:30:00-04:00` * `hierarchy_detail.partition_detail.table = "table1"`
+  parent: string, Required. Name of transfer configuration for which transfer resources should be retrieved. The name should be in one of the following forms: * `projects/{project}/transferConfigs/{transfer_config}` * `projects/{project}/locations/{location_id}/transferConfigs/{transfer_config}` (required)
+  filter: string, Optional. Filter for the transfer resources. Currently supported filters include: * Resource name: `name` - Wildcard supported * Resource type: `type` * Resource destination: `destination` * Latest resource state: `latest_status_detail.state` * Last update time: `update_time` - RFC-3339 format * Parent table name: `hierarchy_detail.partition_detail.table` Multiple filters can be applied using the `AND/OR` operator. Examples: * `name="*123" AND (type="TABLE" OR latest_status_detail.state="SUCCEEDED")` * `update_time >= "2012-04-21T11:30:00-04:00"` * `hierarchy_detail.partition_detail.table = "table1"`
   pageSize: integer, Optional. The maximum number of transfer resources to return. The maximum value is 1000; values above 1000 will be coerced to 1000. The default page size is the maximum value of 1000 results.
   pageToken: string, Optional. A page token, received from a previous `ListTransferResources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTransferResources` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
@@ -172,10 +172,10 @@ 

Method Details

Returns: An object of the form: - { # Response for the ListTransferResources RPC. + { # Response for the `ListTransferResources` RPC. "nextPageToken": "A String", # Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "transferResources": [ # Output only. The transfer resources. - { # Resource(table/partition) that is being transferred. + { # Resource (table/partition) that is being transferred. "destination": "A String", # Optional. Resource destination. "hierarchyDetail": { # Details about the hierarchy. # Optional. Details about the hierarchy. "partitionDetail": { # Partition details related to hierarchy. # Optional. Partition details related to hierarchy. @@ -186,11 +186,11 @@

Method Details

}, }, "lastSuccessfulRun": { # Basic information about a transfer run. # Output only. Run details for the last successful run. - "run": "A String", # Optional. Run URI. Format projects/{project}/locations/{location}/transferConfigs/{config}/run/{run} + "run": "A String", # Optional. Run URI. The format must be: `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/run/{run}` "startTime": "A String", # Optional. Start time of the transfer run. }, "latestRun": { # Basic information about a transfer run. # Optional. Run details for the latest run. - "run": "A String", # Optional. Run URI. Format projects/{project}/locations/{location}/transferConfigs/{config}/run/{run} + "run": "A String", # Optional. Run URI. The format must be: `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/run/{run}` "startTime": "A String", # Optional. Start time of the transfer run. }, "latestStatusDetail": { # Status details of the resource being transferred. # Optional. Status details for the latest run. diff --git a/docs/dyn/classroom_v1.courses.html b/docs/dyn/classroom_v1.courses.html index f354fe10e3..ed53324c84 100644 --- a/docs/dyn/classroom_v1.courses.html +++ b/docs/dyn/classroom_v1.courses.html @@ -462,8 +462,8 @@

Method Details

SUSPENDED - The course has been suspended. You cannot modify the course, and only the user identified by the `owner_id` can view the course. A course may be placed in this state if it potentially violates the Terms of Service. pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. - studentId: string, Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user - teacherId: string, Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user + studentId: string, Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user If specified, `teacher_id` must be empty. + teacherId: string, Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user If specified, `student_id` must be empty. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/datalineage_v1.projects.locations.processes.html b/docs/dyn/datalineage_v1.projects.locations.processes.html index 9d729fdcc3..fdc4a51281 100644 --- a/docs/dyn/datalineage_v1.projects.locations.processes.html +++ b/docs/dyn/datalineage_v1.projects.locations.processes.html @@ -155,7 +155,7 @@

Method Details

Args: name: string, Required. The name of the process to delete. (required) - allowMissing: boolean, If set to true and the process is not found, the request succeeds but the server doesn't perform any actions. + allowMissing: boolean, Optional. If set to true and the process is not found, the request succeeds but the server doesn't perform any actions. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -218,8 +218,8 @@

Method Details

Args: parent: string, Required. The name of the project and its location that owns this collection of processes. (required) - pageSize: integer, The maximum number of processes to return. The service may return fewer than this value. If unspecified, at most 50 processes are returned. The maximum value is 100; values greater than 100 are cut to 100. - pageToken: string, The page token received from a previous `ListProcesses` call. Specify it to get the next page. When paginating, all other parameters specified in this call must match the parameters of the call that provided the page token. + pageSize: integer, Optional. The maximum number of processes to return. The service may return fewer than this value. If unspecified, at most 50 processes are returned. The maximum value is 100; values greater than 100 are cut to 100. + pageToken: string, Optional. The page token received from a previous `ListProcesses` call. Specify it to get the next page. When paginating, all other parameters specified in this call must match the parameters of the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -281,9 +281,9 @@

Method Details

}, } - allowMissing: boolean, If set to true and the process is not found, the request inserts it. + allowMissing: boolean, Optional. If set to true and the process is not found, the request inserts it. requestId: string, Optional. A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is idempotent only if a `request_id` is provided. - updateMask: string, The list of fields to update. Currently not used. The whole message is updated. + updateMask: string, Optional. The list of fields to update. Currently not used. The whole message is updated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/datalineage_v1.projects.locations.processes.runs.html b/docs/dyn/datalineage_v1.projects.locations.processes.runs.html index 3c0f7a00e3..e01ec3d3fc 100644 --- a/docs/dyn/datalineage_v1.projects.locations.processes.runs.html +++ b/docs/dyn/datalineage_v1.projects.locations.processes.runs.html @@ -153,7 +153,7 @@

Method Details

Args: name: string, Required. The name of the run to delete. (required) - allowMissing: boolean, If set to true and the run is not found, the request succeeds but the server doesn't perform any actions. + allowMissing: boolean, Optional. If set to true and the run is not found, the request succeeds but the server doesn't perform any actions. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -215,8 +215,8 @@

Method Details

Args: parent: string, Required. The name of process that owns this collection of runs. (required) - pageSize: integer, The maximum number of runs to return. The service may return fewer than this value. If unspecified, at most 50 runs are returned. The maximum value is 100; values greater than 100 are cut to 100. - pageToken: string, The page token received from a previous `ListRuns` call. Specify it to get the next page. When paginating, all other parameters specified in this call must match the parameters of the call that provided the page token. + pageSize: integer, Optional. The maximum number of runs to return. The service may return fewer than this value. If unspecified, at most 50 runs are returned. The maximum value is 100; values greater than 100 are cut to 100. + pageToken: string, Optional. The page token received from a previous `ListRuns` call. Specify it to get the next page. When paginating, all other parameters specified in this call must match the parameters of the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -276,8 +276,8 @@

Method Details

"state": "A String", # Required. The state of the run. } - allowMissing: boolean, If set to true and the run is not found, the request creates it. - updateMask: string, The list of fields to update. Currently not used. The whole message is updated. + allowMissing: boolean, Optional. If set to true and the run is not found, the request creates it. + updateMask: string, Optional. The list of fields to update. Currently not used. The whole message is updated. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/datalineage_v1.projects.locations.processes.runs.lineageEvents.html b/docs/dyn/datalineage_v1.projects.locations.processes.runs.lineageEvents.html index 3ab8d91202..eb63e8f1c3 100644 --- a/docs/dyn/datalineage_v1.projects.locations.processes.runs.lineageEvents.html +++ b/docs/dyn/datalineage_v1.projects.locations.processes.runs.lineageEvents.html @@ -155,7 +155,7 @@

Method Details

Args: name: string, Required. The name of the lineage event to delete. (required) - allowMissing: boolean, If set to true and the lineage event is not found, the request succeeds but the server doesn't perform any actions. + allowMissing: boolean, Optional. If set to true and the lineage event is not found, the request succeeds but the server doesn't perform any actions. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -205,8 +205,8 @@

Method Details

Args: parent: string, Required. The name of the run that owns the collection of lineage events to get. (required) - pageSize: integer, The maximum number of lineage events to return. The service may return fewer events than this value. If unspecified, at most 50 events are returned. The maximum value is 100; values greater than 100 are cut to 100. - pageToken: string, The page token received from a previous `ListLineageEvents` call. Specify it to get the next page. When paginating, all other parameters specified in this call must match the parameters of the call that provided the page token. + pageSize: integer, Optional. The maximum number of lineage events to return. The service may return fewer events than this value. If unspecified, at most 50 events are returned. The maximum value is 100; values greater than 100 are cut to 100. + pageToken: string, Optional. The page token received from a previous `ListLineageEvents` call. Specify it to get the next page. When paginating, all other parameters specified in this call must match the parameters of the call that provided the page token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/dns_v1.resourceRecordSets.html b/docs/dyn/dns_v1.resourceRecordSets.html index eefffd3e17..ef095db7e3 100644 --- a/docs/dyn/dns_v1.resourceRecordSets.html +++ b/docs/dyn/dns_v1.resourceRecordSets.html @@ -577,11 +577,11 @@

Method Details

Args: project: string, Identifies the project addressed by this request. (required) managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required) - filter: string, Specify a filter expression to view records that exactly match the specified domain. Both the name and type parameters are not supported when you use filter and must be omitted. Your filter expression must conform to AIP-160 and you must specify a domain in the name field. Optionally, you can include the type field to filter records by type. You can also include the has_suffix function to view records that match by domain suffix. Examples: - name="example.com." - name="example.com." AND type="A" - name=has_suffix("example.com.") - name=has_suffix("example.com.") AND type="A" + filter: string, Specify a filter expression to view records that exactly match the specified domain. Both the `name` and `type` parameters are not supported and must be omitted when you use `filter`. Your `filter` expression must conform to AIP-160 and you must specify a domain in the `name` field. Optionally, you can include the `type` field to filter records by type. You can also include the `has_suffix` function to view records that match by domain suffix. Examples: * `name`="example.com." * `name`="example.com." AND type="A" * `name`=`has_suffix`("example.com.") * `name`=`has_suffix`("example.com.") AND type="A" maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return. - name: string, Specify a fully qualified domain name to view only those records. The name parameter is not supported and must be omitted when you use filter. + name: string, Specify a fully qualified domain name to view only those records. The `name` parameter is not supported and must be omitted when you use `filter`. pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. - type: string, Specify a record type to view only those records. You must also specify the name parameter. The type parameter is not supported and must be omitted when you use filter. + type: string, Specify a record type to view only those records. You must also specify the `name` parameter. The `type` parameter is not supported and must be omitted when you use `filter`. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/dns_v1beta2.resourceRecordSets.html b/docs/dyn/dns_v1beta2.resourceRecordSets.html index b12ec3cb95..70120062a5 100644 --- a/docs/dyn/dns_v1beta2.resourceRecordSets.html +++ b/docs/dyn/dns_v1beta2.resourceRecordSets.html @@ -767,11 +767,11 @@

Method Details

Args: project: string, Identifies the project addressed by this request. (required) managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required) - filter: string, Specify a filter expression to view records that exactly match the specified domain. Both the name and type parameters are not supported when you use filter and must be omitted. Your filter expression must conform to AIP-160 and you must specify a domain in the name field. Optionally, you can include the type field to filter records by type. You can also include the has_suffix function to view records that match by domain suffix. Examples: - name="example.com." - name="example.com." AND type="A" - name=has_suffix("example.com.") - name=has_suffix("example.com.") AND type="A" + filter: string, Specify a filter expression to view records that exactly match the specified domain. Both the `name` and `type` parameters are not supported and must be omitted when you use `filter`. Your `filter` expression must conform to AIP-160 and you must specify a domain in the `name` field. Optionally, you can include the `type` field to filter records by type. You can also include the `has_suffix` function to view records that match by domain suffix. Examples: * `name`="example.com." * `name`="example.com." AND type="A" * `name`=`has_suffix`("example.com.") * `name`=`has_suffix`("example.com.") AND type="A" maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return. - name: string, Specify a fully qualified domain name to view only those records. The name parameter is not supported and must be omitted when you use filter. + name: string, Specify a fully qualified domain name to view only those records. The `name` parameter is not supported and must be omitted when you use `filter`. pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. - type: string, Specify a record type to view only those records. You must also specify the name parameter. The type parameter is not supported and must be omitted when you use filter. + type: string, Specify a record type to view only those records. You must also specify the `name` parameter. The `type` parameter is not supported and must be omitted when you use `filter`. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/monitoring_v1.projects.dashboards.html b/docs/dyn/monitoring_v1.projects.dashboards.html index b2e2e2171a..235d59dcc5 100644 --- a/docs/dyn/monitoring_v1.projects.dashboards.html +++ b/docs/dyn/monitoring_v1.projects.dashboards.html @@ -347,7 +347,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -766,7 +766,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -1216,7 +1216,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -1635,7 +1635,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -1981,7 +1981,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -2400,7 +2400,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -2748,7 +2748,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -3167,7 +3167,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -3540,7 +3540,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -3959,7 +3959,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -4409,7 +4409,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -4828,7 +4828,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -5174,7 +5174,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -5593,7 +5593,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -5941,7 +5941,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -6360,7 +6360,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -6757,7 +6757,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -7176,7 +7176,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -7626,7 +7626,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -8045,7 +8045,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -8391,7 +8391,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -8810,7 +8810,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -9158,7 +9158,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -9577,7 +9577,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -9960,7 +9960,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -10379,7 +10379,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -10829,7 +10829,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -11248,7 +11248,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -11594,7 +11594,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -12013,7 +12013,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -12361,7 +12361,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -12780,7 +12780,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -13171,7 +13171,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -13590,7 +13590,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -14040,7 +14040,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -14459,7 +14459,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -14805,7 +14805,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -15224,7 +15224,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -15572,7 +15572,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -15991,7 +15991,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -16364,7 +16364,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -16783,7 +16783,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -17233,7 +17233,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -17652,7 +17652,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -17998,7 +17998,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -18417,7 +18417,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy @@ -18765,7 +18765,7 @@

Method Details

}, ], "sparkChartView": { # A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries. # Will cause the scorecard to show a spark chart. - "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint. + "minAlignmentPeriod": "A String", # The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "sparkChartType": "A String", # Required. The type of sparkchart to show in this chartView. }, "thresholds": [ # The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state. @@ -19184,7 +19184,7 @@

Method Details

"column": "A String", # Required. The column name within in the dataset used for the measure. }, ], - "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. + "minAlignmentPeriod": "A String", # Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. "plotType": "A String", # How this data should be plotted on the chart. "sort": [ # Optional. A collection of sort options, affects the order of the data and legend. { # Data structure to storing column's sort strategy diff --git a/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html b/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html index 2e6bbc493c..b3f6b0c72d 100644 --- a/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html +++ b/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html @@ -207,7 +207,7 @@

Method Details

], "primaryPhone": "A String", # Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible. }, - "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g. hotels, motels, inns). + "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns). "description": "A String", # Required. Description of the location in your own voice, not editable by anyone else. }, "regularHours": { # Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances. # Optional. Operating hours for the business. @@ -443,7 +443,7 @@

Method Details

], "primaryPhone": "A String", # Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible. }, - "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g. hotels, motels, inns). + "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns). "description": "A String", # Required. Description of the location in your own voice, not editable by anyone else. }, "regularHours": { # Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances. # Optional. Operating hours for the business. @@ -691,7 +691,7 @@

Method Details

], "primaryPhone": "A String", # Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible. }, - "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g. hotels, motels, inns). + "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns). "description": "A String", # Required. Description of the location in your own voice, not editable by anyone else. }, "regularHours": { # Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances. # Optional. Operating hours for the business. diff --git a/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html b/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html index e490d42522..e4e0240b24 100644 --- a/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html +++ b/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html @@ -201,7 +201,7 @@

Method Details

], "primaryPhone": "A String", # Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible. }, - "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g. hotels, motels, inns). + "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns). "description": "A String", # Required. Description of the location in your own voice, not editable by anyone else. }, "regularHours": { # Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances. # Optional. Operating hours for the business. @@ -441,7 +441,7 @@

Method Details

], "primaryPhone": "A String", # Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible. }, - "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g. hotels, motels, inns). + "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns). "description": "A String", # Required. Description of the location in your own voice, not editable by anyone else. }, "regularHours": { # Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances. # Optional. Operating hours for the business. diff --git a/docs/dyn/mybusinessbusinessinformation_v1.locations.html b/docs/dyn/mybusinessbusinessinformation_v1.locations.html index 85c57b5e52..2148aba787 100644 --- a/docs/dyn/mybusinessbusinessinformation_v1.locations.html +++ b/docs/dyn/mybusinessbusinessinformation_v1.locations.html @@ -245,7 +245,7 @@

Method Details

], "primaryPhone": "A String", # Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible. }, - "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g. hotels, motels, inns). + "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns). "description": "A String", # Required. Description of the location in your own voice, not editable by anyone else. }, "regularHours": { # Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances. # Optional. Operating hours for the business. @@ -530,7 +530,7 @@

Method Details

], "primaryPhone": "A String", # Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible. }, - "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g. hotels, motels, inns). + "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns). "description": "A String", # Required. Description of the location in your own voice, not editable by anyone else. }, "regularHours": { # Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances. # Optional. Operating hours for the business. @@ -768,7 +768,7 @@

Method Details

], "primaryPhone": "A String", # Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible. }, - "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g. hotels, motels, inns). + "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns). "description": "A String", # Required. Description of the location in your own voice, not editable by anyone else. }, "regularHours": { # Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances. # Optional. Operating hours for the business. @@ -1004,7 +1004,7 @@

Method Details

], "primaryPhone": "A String", # Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible. }, - "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g. hotels, motels, inns). + "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns). "description": "A String", # Required. Description of the location in your own voice, not editable by anyone else. }, "regularHours": { # Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances. # Optional. Operating hours for the business. diff --git a/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html b/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html index e8eb73d354..afac76c8c1 100644 --- a/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html +++ b/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html @@ -335,8 +335,8 @@

Method Details

"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", # 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. + "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. 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, Secure Web Proxy Gateways, or Agent Gateways on which this policy will be applied. "A String", ], }, @@ -640,8 +640,8 @@

Method Details

"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", # 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. + "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. 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, Secure Web Proxy Gateways, or Agent Gateways on which this policy will be applied. "A String", ], }, @@ -933,8 +933,8 @@

Method Details

"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", # 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. + "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. 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, Secure Web Proxy Gateways, or Agent Gateways on which this policy will be applied. "A String", ], }, @@ -1187,8 +1187,8 @@

Method Details

"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", # 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. + "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. 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, Secure Web Proxy Gateways, or Agent Gateways on which this policy will be applied. "A String", ], }, diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html b/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html index f14d1a8c30..d2071184ae 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html @@ -335,8 +335,8 @@

Method Details

"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", # 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. + "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. 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, Secure Web Proxy Gateways, or Agent Gateways on which this policy will be applied. "A String", ], }, @@ -640,8 +640,8 @@

Method Details

"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", # 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. + "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. 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, Secure Web Proxy Gateways, or Agent Gateways on which this policy will be applied. "A String", ], }, @@ -933,8 +933,8 @@

Method Details

"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", # 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. + "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. 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, Secure Web Proxy Gateways, or Agent Gateways on which this policy will be applied. "A String", ], }, @@ -1187,8 +1187,8 @@

Method Details

"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", # 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. + "loadBalancingScheme": "A String", # Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. 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, Secure Web Proxy Gateways, or Agent Gateways on which this policy will be applied. "A String", ], }, diff --git a/docs/dyn/notebooks_v1.projects.locations.html b/docs/dyn/notebooks_v1.projects.locations.html index e060f7ac25..82a1c3a949 100644 --- a/docs/dyn/notebooks_v1.projects.locations.html +++ b/docs/dyn/notebooks_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/notebooks_v2.projects.locations.html b/docs/dyn/notebooks_v2.projects.locations.html
index 7bac8eeaee..6a66958a45 100644
--- a/docs/dyn/notebooks_v2.projects.locations.html
+++ b/docs/dyn/notebooks_v2.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/redis_v1.projects.locations.aclPolicies.html b/docs/dyn/redis_v1.projects.locations.aclPolicies.html
index 1013d2ca15..82ee2860de 100644
--- a/docs/dyn/redis_v1.projects.locations.aclPolicies.html
+++ b/docs/dyn/redis_v1.projects.locations.aclPolicies.html
@@ -219,7 +219,7 @@ 

Method Details

Args: parent: string, Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a Google Cloud region. (required) 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 `next_page_token` to determine if there are more ACL policies left to be queried. The maximum value is 1000; values above 1000 will be coerced to 1000. - pageToken: string, Optional. The `next_page_token` value returned from a previous ListAclPolicies request, if any. + pageToken: string, Optional. The `next_page_token` value returned from a previous `ListAclPolicies` request, if any. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -228,7 +228,7 @@

Method Details

Returns: An object of the form: - { # Response for ListAclPolicies. + { # Response for `ListAclPolicies`. "aclPolicies": [ # A list of ACL policies in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. { # The ACL policy resource. "etag": "A String", # Output only. Etag for the ACL policy. @@ -287,7 +287,7 @@

Method Details

} requestId: string, Optional. Idempotent request UUID. - updateMask: string, Optional. Mask of fields to be updated. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from AclPolicy: * `rules` + updateMask: string, Optional. Mask of fields to be updated. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from `AclPolicy`: * `rules` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/redis_v1.projects.locations.backupCollections.backups.html b/docs/dyn/redis_v1.projects.locations.backupCollections.backups.html index d9d3fe9c28..738e84be69 100644 --- a/docs/dyn/redis_v1.projects.locations.backupCollections.backups.html +++ b/docs/dyn/redis_v1.projects.locations.backupCollections.backups.html @@ -143,7 +143,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Request for [ExportBackup]. +{ # Request for `ExportBackup`. "gcsBucket": "A String", # Google Cloud Storage bucket, like "my-bucket". } @@ -238,7 +238,7 @@

Method Details

Returns: An object of the form: - { # Response for [ListBackups]. + { # Response for `ListBackups`. "backups": [ # A list of backups in the project. { # Backup of a cluster. "backupFiles": [ # Output only. List of backup files of the backup. diff --git a/docs/dyn/redis_v1.projects.locations.backupCollections.html b/docs/dyn/redis_v1.projects.locations.backupCollections.html index 0aa192fea6..9b08176c0d 100644 --- a/docs/dyn/redis_v1.projects.locations.backupCollections.html +++ b/docs/dyn/redis_v1.projects.locations.backupCollections.html @@ -140,7 +140,7 @@

Method Details

Returns: An object of the form: - { # Response for [ListBackupCollections]. + { # Response for `ListBackupCollections`. "backupCollections": [ # A list of backupCollections in the project. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a placeholder backupCollection entry is included in the response with the `name` field set to a value of the form `projects/{project_id}/locations/{location_id}/backupCollections/`- and the `status` field set to ERROR and `status_message` field set to "location not available for ListBackupCollections". { # BackupCollection of a cluster. "cluster": "A String", # Output only. The full resource path of the cluster the backup collection belongs to. Example: projects/{project}/locations/{location}/clusters/{cluster} diff --git a/docs/dyn/redis_v1.projects.locations.clusters.html b/docs/dyn/redis_v1.projects.locations.clusters.html index d68bba2770..64627169b8 100644 --- a/docs/dyn/redis_v1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1.projects.locations.clusters.html @@ -164,7 +164,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Request for [BackupCluster]. +{ # Request for `BackupCluster`. "backupId": "A String", # Optional. The id of the backup to be created. If not specified, the default value ([YYYYMMDDHHMMSS]_[Shortened Cluster UID] is used. "ttl": "A String", # Optional. TTL for the backup to expire. Value range is 1 day to 100 years. If not specified, the default value is 100 years. } @@ -719,7 +719,7 @@

Method Details

Args: parent: string, Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a Google Cloud region. (required) pageSize: integer, 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 `next_page_token` to determine if there are more clusters left to be queried. - pageToken: string, The `next_page_token` value returned from a previous ListClusters request, if any. + pageToken: string, The `next_page_token` value returned from a previous `ListClusters` request, if any. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -728,7 +728,7 @@

Method Details

Returns: An object of the form: - { # Response for ListClusters. + { # Response for `ListClusters`. "clusters": [ # A list of Redis clusters in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a placeholder Redis entry is included in the response with the `name` field set to a value of the form `projects/{project_id}/locations/{location_id}/clusters/`- and the `status` field set to ERROR and `status_message` field set to "location not available for ListClusters". { # A cluster instance. "aclPolicy": "A String", # Optional. The ACL policy to be applied to the cluster. diff --git a/docs/dyn/redis_v1beta1.projects.locations.aclPolicies.html b/docs/dyn/redis_v1beta1.projects.locations.aclPolicies.html index 5d93a5f64f..3078cd15e3 100644 --- a/docs/dyn/redis_v1beta1.projects.locations.aclPolicies.html +++ b/docs/dyn/redis_v1beta1.projects.locations.aclPolicies.html @@ -219,7 +219,7 @@

Method Details

Args: parent: string, Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a Google Cloud region. (required) 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 `next_page_token` to determine if there are more ACL policies left to be queried. The maximum value is 1000; values above 1000 will be coerced to 1000. - pageToken: string, Optional. The `next_page_token` value returned from a previous ListAclPolicies request, if any. + pageToken: string, Optional. The `next_page_token` value returned from a previous `ListAclPolicies` request, if any. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -228,7 +228,7 @@

Method Details

Returns: An object of the form: - { # Response for ListAclPolicies. + { # Response for `ListAclPolicies`. "aclPolicies": [ # A list of ACL policies in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. { # The ACL policy resource. "etag": "A String", # Output only. Etag for the ACL policy. @@ -287,7 +287,7 @@

Method Details

} requestId: string, Optional. Idempotent request UUID. - updateMask: string, Optional. Mask of fields to be updated. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from AclPolicy: * `rules` + updateMask: string, Optional. Mask of fields to be updated. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from `AclPolicy`: * `rules` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/redis_v1beta1.projects.locations.backupCollections.backups.html b/docs/dyn/redis_v1beta1.projects.locations.backupCollections.backups.html index 5701f9f075..0767833815 100644 --- a/docs/dyn/redis_v1beta1.projects.locations.backupCollections.backups.html +++ b/docs/dyn/redis_v1beta1.projects.locations.backupCollections.backups.html @@ -143,7 +143,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Request for [ExportBackup]. +{ # Request for `ExportBackup`. "gcsBucket": "A String", # Google Cloud Storage bucket, like "my-bucket". } @@ -238,7 +238,7 @@

Method Details

Returns: An object of the form: - { # Response for [ListBackups]. + { # Response for `ListBackups`. "backups": [ # A list of backups in the project. { # Backup of a cluster. "backupFiles": [ # Output only. List of backup files of the backup. diff --git a/docs/dyn/redis_v1beta1.projects.locations.backupCollections.html b/docs/dyn/redis_v1beta1.projects.locations.backupCollections.html index 584cf8dd89..3ab01ab8ae 100644 --- a/docs/dyn/redis_v1beta1.projects.locations.backupCollections.html +++ b/docs/dyn/redis_v1beta1.projects.locations.backupCollections.html @@ -140,7 +140,7 @@

Method Details

Returns: An object of the form: - { # Response for [ListBackupCollections]. + { # Response for `ListBackupCollections`. "backupCollections": [ # A list of backupCollections in the project. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a placeholder backupCollection entry is included in the response with the `name` field set to a value of the form `projects/{project_id}/locations/{location_id}/backupCollections/`- and the `status` field set to ERROR and `status_message` field set to "location not available for ListBackupCollections". { # BackupCollection of a cluster. "cluster": "A String", # Output only. The full resource path of the cluster the backup collection belongs to. Example: projects/{project}/locations/{location}/clusters/{cluster} diff --git a/docs/dyn/redis_v1beta1.projects.locations.clusters.html b/docs/dyn/redis_v1beta1.projects.locations.clusters.html index d7c9890966..acc3961515 100644 --- a/docs/dyn/redis_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1beta1.projects.locations.clusters.html @@ -164,7 +164,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Request for [BackupCluster]. +{ # Request for `BackupCluster`. "backupId": "A String", # Optional. The id of the backup to be created. If not specified, the default value ([YYYYMMDDHHMMSS]_[Shortened Cluster UID] is used. "ttl": "A String", # Optional. TTL for the backup to expire. Value range is 1 day to 100 years. If not specified, the default value is 100 years. } @@ -719,7 +719,7 @@

Method Details

Args: parent: string, Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a Google Cloud region. (required) pageSize: integer, 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 `next_page_token` to determine if there are more clusters left to be queried. - pageToken: string, The `next_page_token` value returned from a previous ListClusters request, if any. + pageToken: string, The `next_page_token` value returned from a previous `ListClusters` request, if any. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -728,7 +728,7 @@

Method Details

Returns: An object of the form: - { # Response for ListClusters. + { # Response for `ListClusters`. "clusters": [ # A list of Redis clusters in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a placeholder Redis entry is included in the response with the `name` field set to a value of the form `projects/{project_id}/locations/{location_id}/clusters/`- and the `status` field set to ERROR and `status_message` field set to "location not available for ListClusters". { # A cluster instance. "aclPolicy": "A String", # Optional. The ACL policy to be applied to the cluster. diff --git a/docs/dyn/servicemanagement_v1.services.configs.html b/docs/dyn/servicemanagement_v1.services.configs.html index aef06cb116..6d26facbde 100644 --- a/docs/dyn/servicemanagement_v1.services.configs.html +++ b/docs/dyn/servicemanagement_v1.services.configs.html @@ -215,7 +215,7 @@

Method Details

"overridesByRequestProtocol": { # The map between request protocol and the backend address. "a_key": # Object with schema name: BackendRule }, - "pathTranslation": "A String", # no-lint + "pathTranslation": "A String", # Path translation specifies how to combine the backend address with the request path in order to produce the appropriate forwarding URL for the request. See PathTranslation for more details. "protocol": "A String", # The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. }, @@ -310,7 +310,7 @@

Method Details

"serviceRootUrl": "A String", # Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to. "summary": "A String", # A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field `description`. }, - "endpoints": [ # Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. WARNING: Defining any entries in the `endpoints` list disables the automatic generation of default endpoint variations (e.g., `{service}.clients6.google.com`, `content-{service}.googleapis.com`, and mTLS variants like `{service}.mtls.googleapis.com`). To retain these default variations, you are required to explicitly include your main service endpoint (e.g., `myservice.googleapis.com`) in this list alongside any other custom endpoints (like REP, GFE, etc.). + "endpoints": [ # Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. { # `Endpoint` describes a network address of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example: type: google.api.Service name: library-example.googleapis.com endpoints: # Declares network address `https://library-example.googleapis.com` # for service `library-example.googleapis.com`. The `https` scheme # is implicit for all service endpoints. Other schemes may be # supported in the future. - name: library-example.googleapis.com allow_cors: false - name: content-staging-library-example.googleapis.com # Allows HTTP OPTIONS calls to be passed to the API frontend, for it # to decide whether the subsequent cross-origin request is allowed # to proceed. allow_cors: true "aliases": [ # Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and will be provisioned in the GCP stack for the Regional Endpoints. "A String", @@ -489,7 +489,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -503,7 +503,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -532,7 +532,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -549,7 +549,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -568,7 +568,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -582,7 +582,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -597,7 +597,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -617,7 +617,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -805,7 +805,7 @@

Method Details

], "rules": [ # A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. { # Usage configuration rules for the service. - "allowUnregisteredCalls": True or False, # Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. + "allowUnregisteredCalls": True or False, # Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. "skipServiceControl": True or False, # If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. }, @@ -929,7 +929,7 @@

Method Details

"overridesByRequestProtocol": { # The map between request protocol and the backend address. "a_key": # Object with schema name: BackendRule }, - "pathTranslation": "A String", # no-lint + "pathTranslation": "A String", # Path translation specifies how to combine the backend address with the request path in order to produce the appropriate forwarding URL for the request. See PathTranslation for more details. "protocol": "A String", # The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. }, @@ -1024,7 +1024,7 @@

Method Details

"serviceRootUrl": "A String", # Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to. "summary": "A String", # A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field `description`. }, - "endpoints": [ # Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. WARNING: Defining any entries in the `endpoints` list disables the automatic generation of default endpoint variations (e.g., `{service}.clients6.google.com`, `content-{service}.googleapis.com`, and mTLS variants like `{service}.mtls.googleapis.com`). To retain these default variations, you are required to explicitly include your main service endpoint (e.g., `myservice.googleapis.com`) in this list alongside any other custom endpoints (like REP, GFE, etc.). + "endpoints": [ # Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. { # `Endpoint` describes a network address of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example: type: google.api.Service name: library-example.googleapis.com endpoints: # Declares network address `https://library-example.googleapis.com` # for service `library-example.googleapis.com`. The `https` scheme # is implicit for all service endpoints. Other schemes may be # supported in the future. - name: library-example.googleapis.com allow_cors: false - name: content-staging-library-example.googleapis.com # Allows HTTP OPTIONS calls to be passed to the API frontend, for it # to decide whether the subsequent cross-origin request is allowed # to proceed. allow_cors: true "aliases": [ # Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and will be provisioned in the GCP stack for the Regional Endpoints. "A String", @@ -1203,7 +1203,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -1217,7 +1217,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -1246,7 +1246,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -1263,7 +1263,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -1282,7 +1282,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -1296,7 +1296,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -1311,7 +1311,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -1331,7 +1331,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -1519,7 +1519,7 @@

Method Details

], "rules": [ # A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. { # Usage configuration rules for the service. - "allowUnregisteredCalls": True or False, # Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. + "allowUnregisteredCalls": True or False, # Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. "skipServiceControl": True or False, # If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. }, @@ -1655,7 +1655,7 @@

Method Details

"overridesByRequestProtocol": { # The map between request protocol and the backend address. "a_key": # Object with schema name: BackendRule }, - "pathTranslation": "A String", # no-lint + "pathTranslation": "A String", # Path translation specifies how to combine the backend address with the request path in order to produce the appropriate forwarding URL for the request. See PathTranslation for more details. "protocol": "A String", # The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. }, @@ -1750,7 +1750,7 @@

Method Details

"serviceRootUrl": "A String", # Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to. "summary": "A String", # A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field `description`. }, - "endpoints": [ # Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. WARNING: Defining any entries in the `endpoints` list disables the automatic generation of default endpoint variations (e.g., `{service}.clients6.google.com`, `content-{service}.googleapis.com`, and mTLS variants like `{service}.mtls.googleapis.com`). To retain these default variations, you are required to explicitly include your main service endpoint (e.g., `myservice.googleapis.com`) in this list alongside any other custom endpoints (like REP, GFE, etc.). + "endpoints": [ # Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. { # `Endpoint` describes a network address of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example: type: google.api.Service name: library-example.googleapis.com endpoints: # Declares network address `https://library-example.googleapis.com` # for service `library-example.googleapis.com`. The `https` scheme # is implicit for all service endpoints. Other schemes may be # supported in the future. - name: library-example.googleapis.com allow_cors: false - name: content-staging-library-example.googleapis.com # Allows HTTP OPTIONS calls to be passed to the API frontend, for it # to decide whether the subsequent cross-origin request is allowed # to proceed. allow_cors: true "aliases": [ # Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and will be provisioned in the GCP stack for the Regional Endpoints. "A String", @@ -1929,7 +1929,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -1943,7 +1943,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -1972,7 +1972,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -1989,7 +1989,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -2008,7 +2008,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -2022,7 +2022,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -2037,7 +2037,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -2057,7 +2057,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -2245,7 +2245,7 @@

Method Details

], "rules": [ # A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. { # Usage configuration rules for the service. - "allowUnregisteredCalls": True or False, # Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. + "allowUnregisteredCalls": True or False, # Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. "skipServiceControl": True or False, # If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. }, @@ -2381,7 +2381,7 @@

Method Details

"overridesByRequestProtocol": { # The map between request protocol and the backend address. "a_key": # Object with schema name: BackendRule }, - "pathTranslation": "A String", # no-lint + "pathTranslation": "A String", # Path translation specifies how to combine the backend address with the request path in order to produce the appropriate forwarding URL for the request. See PathTranslation for more details. "protocol": "A String", # The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. }, @@ -2476,7 +2476,7 @@

Method Details

"serviceRootUrl": "A String", # Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to. "summary": "A String", # A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field `description`. }, - "endpoints": [ # Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. WARNING: Defining any entries in the `endpoints` list disables the automatic generation of default endpoint variations (e.g., `{service}.clients6.google.com`, `content-{service}.googleapis.com`, and mTLS variants like `{service}.mtls.googleapis.com`). To retain these default variations, you are required to explicitly include your main service endpoint (e.g., `myservice.googleapis.com`) in this list alongside any other custom endpoints (like REP, GFE, etc.). + "endpoints": [ # Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. { # `Endpoint` describes a network address of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example: type: google.api.Service name: library-example.googleapis.com endpoints: # Declares network address `https://library-example.googleapis.com` # for service `library-example.googleapis.com`. The `https` scheme # is implicit for all service endpoints. Other schemes may be # supported in the future. - name: library-example.googleapis.com allow_cors: false - name: content-staging-library-example.googleapis.com # Allows HTTP OPTIONS calls to be passed to the API frontend, for it # to decide whether the subsequent cross-origin request is allowed # to proceed. allow_cors: true "aliases": [ # Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and will be provisioned in the GCP stack for the Regional Endpoints. "A String", @@ -2655,7 +2655,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -2669,7 +2669,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -2698,7 +2698,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -2715,7 +2715,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -2734,7 +2734,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -2748,7 +2748,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -2763,7 +2763,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -2783,7 +2783,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -2971,7 +2971,7 @@

Method Details

], "rules": [ # A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. { # Usage configuration rules for the service. - "allowUnregisteredCalls": True or False, # Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. + "allowUnregisteredCalls": True or False, # Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. "skipServiceControl": True or False, # If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. }, diff --git a/docs/dyn/servicemanagement_v1.services.html b/docs/dyn/servicemanagement_v1.services.html index 1f814fb2ed..978010a155 100644 --- a/docs/dyn/servicemanagement_v1.services.html +++ b/docs/dyn/servicemanagement_v1.services.html @@ -410,7 +410,7 @@

Method Details

"overridesByRequestProtocol": { # The map between request protocol and the backend address. "a_key": # Object with schema name: BackendRule }, - "pathTranslation": "A String", # no-lint + "pathTranslation": "A String", # Path translation specifies how to combine the backend address with the request path in order to produce the appropriate forwarding URL for the request. See PathTranslation for more details. "protocol": "A String", # The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. }, @@ -505,7 +505,7 @@

Method Details

"serviceRootUrl": "A String", # Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to. "summary": "A String", # A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field `description`. }, - "endpoints": [ # Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. WARNING: Defining any entries in the `endpoints` list disables the automatic generation of default endpoint variations (e.g., `{service}.clients6.google.com`, `content-{service}.googleapis.com`, and mTLS variants like `{service}.mtls.googleapis.com`). To retain these default variations, you are required to explicitly include your main service endpoint (e.g., `myservice.googleapis.com`) in this list alongside any other custom endpoints (like REP, GFE, etc.). + "endpoints": [ # Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. { # `Endpoint` describes a network address of a service that serves a set of APIs. It is commonly known as a service endpoint. A service may expose any number of service endpoints, and all service endpoints share the same service definition, such as quota limits and monitoring metrics. Example: type: google.api.Service name: library-example.googleapis.com endpoints: # Declares network address `https://library-example.googleapis.com` # for service `library-example.googleapis.com`. The `https` scheme # is implicit for all service endpoints. Other schemes may be # supported in the future. - name: library-example.googleapis.com allow_cors: false - name: content-staging-library-example.googleapis.com # Allows HTTP OPTIONS calls to be passed to the API frontend, for it # to decide whether the subsequent cross-origin request is allowed # to proceed. allow_cors: true "aliases": [ # Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and will be provisioned in the GCP stack for the Regional Endpoints. "A String", @@ -684,7 +684,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -698,7 +698,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -727,7 +727,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -744,7 +744,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -763,7 +763,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -777,7 +777,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -792,7 +792,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -812,7 +812,7 @@

Method Details

"A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest - "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. # Configuration for which RPCs should be generated in the GAPIC client. + "selectiveGapicGeneration": { # This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases. # Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases. "generateOmittedAsInternal": True or False, # Setting this to true indicates to the client generators that methods that would be excluded from the generation should instead be generated in a way that indicates these methods should not be consumed by end users. How this is expressed is up to individual language implementations to decide. Some examples may be: added annotations, obfuscated identifiers, or other language idiomatic patterns. "methods": [ # An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. "A String", @@ -1000,7 +1000,7 @@

Method Details

], "rules": [ # A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. { # Usage configuration rules for the service. - "allowUnregisteredCalls": True or False, # Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. + "allowUnregisteredCalls": True or False, # Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. "skipServiceControl": True or False, # If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. }, diff --git a/docs/dyn/serviceusage_v1.services.html b/docs/dyn/serviceusage_v1.services.html index add9ef6d2b..393cd5fd53 100644 --- a/docs/dyn/serviceusage_v1.services.html +++ b/docs/dyn/serviceusage_v1.services.html @@ -352,7 +352,7 @@

Method Details

], "rules": [ # A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. { # Usage configuration rules for the service. - "allowUnregisteredCalls": True or False, # Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. + "allowUnregisteredCalls": True or False, # Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. "skipServiceControl": True or False, # If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. }, @@ -662,7 +662,7 @@

Method Details

], "rules": [ # A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. { # Usage configuration rules for the service. - "allowUnregisteredCalls": True or False, # Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. + "allowUnregisteredCalls": True or False, # Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. "skipServiceControl": True or False, # If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. }, @@ -887,7 +887,7 @@

Method Details

], "rules": [ # A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. { # Usage configuration rules for the service. - "allowUnregisteredCalls": True or False, # Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. + "allowUnregisteredCalls": True or False, # Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. "skipServiceControl": True or False, # If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. }, diff --git a/docs/dyn/serviceusage_v1beta1.services.html b/docs/dyn/serviceusage_v1beta1.services.html index b423ae0a2a..3cad9cb2c0 100644 --- a/docs/dyn/serviceusage_v1beta1.services.html +++ b/docs/dyn/serviceusage_v1beta1.services.html @@ -476,7 +476,7 @@

Method Details

], "rules": [ # A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. { # Usage configuration rules for the service. - "allowUnregisteredCalls": True or False, # Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. + "allowUnregisteredCalls": True or False, # Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. "skipServiceControl": True or False, # If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. }, @@ -701,7 +701,7 @@

Method Details

], "rules": [ # A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. { # Usage configuration rules for the service. - "allowUnregisteredCalls": True or False, # Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. + "allowUnregisteredCalls": True or False, # Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. "selector": "A String", # Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. "skipServiceControl": True or False, # If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud Endpoints to bypass checks for internal methods, such as service health check methods. }, diff --git a/docs/dyn/slides_v1.presentations.pages.html b/docs/dyn/slides_v1.presentations.pages.html index 9763617244..b2d39265db 100644 --- a/docs/dyn/slides_v1.presentations.pages.html +++ b/docs/dyn/slides_v1.presentations.pages.html @@ -1183,6 +1183,7 @@

Method Details

LARGE - The thumbnail image width of 1600px. MEDIUM - The thumbnail image width of 800px. SMALL - The thumbnail image width of 200px. + WIDTH2000_PX - The thumbnail image width of 2000px. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html index 49986a0257..ef5f4643c8 100644 --- a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html +++ b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html @@ -497,7 +497,7 @@

Method Details

}, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. "multiplexedSessionPreviousTransactionId": "A String", # Optional. Clients should pass the transaction ID of the previous transaction attempt that was aborted if this transaction is being executed on a multiplexed session. - "readLockMode": "A String", # Read lock mode for the transaction. + "readLockMode": "A String", # The read lock mode for the transaction. }, }, "requestOptions": { # Common request options for various APIs. # Common options for this request. Priority is ignored for this request. Setting the priority in this `request_options` struct doesn't do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead. @@ -666,7 +666,7 @@

Method Details

}, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. "multiplexedSessionPreviousTransactionId": "A String", # Optional. Clients should pass the transaction ID of the previous transaction attempt that was aborted if this transaction is being executed on a multiplexed session. - "readLockMode": "A String", # Read lock mode for the transaction. + "readLockMode": "A String", # The read lock mode for the transaction. }, }, "transactionId": "A String", # Commit a previously-started transaction. @@ -815,7 +815,7 @@

Method Details

}, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. "multiplexedSessionPreviousTransactionId": "A String", # Optional. Clients should pass the transaction ID of the previous transaction attempt that was aborted if this transaction is being executed on a multiplexed session. - "readLockMode": "A String", # Read lock mode for the transaction. + "readLockMode": "A String", # The read lock mode for the transaction. }, }, "id": "A String", # Execute the read or SQL query in a previously-started transaction. @@ -834,7 +834,7 @@

Method Details

}, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. "multiplexedSessionPreviousTransactionId": "A String", # Optional. Clients should pass the transaction ID of the previous transaction attempt that was aborted if this transaction is being executed on a multiplexed session. - "readLockMode": "A String", # Read lock mode for the transaction. + "readLockMode": "A String", # The read lock mode for the transaction. }, }, }, @@ -1034,7 +1034,7 @@

Method Details

}, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. "multiplexedSessionPreviousTransactionId": "A String", # Optional. Clients should pass the transaction ID of the previous transaction attempt that was aborted if this transaction is being executed on a multiplexed session. - "readLockMode": "A String", # Read lock mode for the transaction. + "readLockMode": "A String", # The read lock mode for the transaction. }, }, "id": "A String", # Execute the read or SQL query in a previously-started transaction. @@ -1053,7 +1053,7 @@

Method Details

}, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. "multiplexedSessionPreviousTransactionId": "A String", # Optional. Clients should pass the transaction ID of the previous transaction attempt that was aborted if this transaction is being executed on a multiplexed session. - "readLockMode": "A String", # Read lock mode for the transaction. + "readLockMode": "A String", # The read lock mode for the transaction. }, }, }, @@ -1236,7 +1236,7 @@

Method Details

}, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. "multiplexedSessionPreviousTransactionId": "A String", # Optional. Clients should pass the transaction ID of the previous transaction attempt that was aborted if this transaction is being executed on a multiplexed session. - "readLockMode": "A String", # Read lock mode for the transaction. + "readLockMode": "A String", # The read lock mode for the transaction. }, }, "id": "A String", # Execute the read or SQL query in a previously-started transaction. @@ -1255,7 +1255,7 @@

Method Details

}, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. "multiplexedSessionPreviousTransactionId": "A String", # Optional. Clients should pass the transaction ID of the previous transaction attempt that was aborted if this transaction is being executed on a multiplexed session. - "readLockMode": "A String", # Read lock mode for the transaction. + "readLockMode": "A String", # The read lock mode for the transaction. }, }, }, @@ -1478,7 +1478,7 @@

Method Details

}, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. "multiplexedSessionPreviousTransactionId": "A String", # Optional. Clients should pass the transaction ID of the previous transaction attempt that was aborted if this transaction is being executed on a multiplexed session. - "readLockMode": "A String", # Read lock mode for the transaction. + "readLockMode": "A String", # The read lock mode for the transaction. }, }, "id": "A String", # Execute the read or SQL query in a previously-started transaction. @@ -1497,7 +1497,7 @@

Method Details

}, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. "multiplexedSessionPreviousTransactionId": "A String", # Optional. Clients should pass the transaction ID of the previous transaction attempt that was aborted if this transaction is being executed on a multiplexed session. - "readLockMode": "A String", # Read lock mode for the transaction. + "readLockMode": "A String", # The read lock mode for the transaction. }, }, }, @@ -1587,7 +1587,7 @@

Method Details

}, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. "multiplexedSessionPreviousTransactionId": "A String", # Optional. Clients should pass the transaction ID of the previous transaction attempt that was aborted if this transaction is being executed on a multiplexed session. - "readLockMode": "A String", # Read lock mode for the transaction. + "readLockMode": "A String", # The read lock mode for the transaction. }, }, "id": "A String", # Execute the read or SQL query in a previously-started transaction. @@ -1606,7 +1606,7 @@

Method Details

}, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. "multiplexedSessionPreviousTransactionId": "A String", # Optional. Clients should pass the transaction ID of the previous transaction attempt that was aborted if this transaction is being executed on a multiplexed session. - "readLockMode": "A String", # Read lock mode for the transaction. + "readLockMode": "A String", # The read lock mode for the transaction. }, }, }, @@ -1727,7 +1727,7 @@

Method Details

}, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. "multiplexedSessionPreviousTransactionId": "A String", # Optional. Clients should pass the transaction ID of the previous transaction attempt that was aborted if this transaction is being executed on a multiplexed session. - "readLockMode": "A String", # Read lock mode for the transaction. + "readLockMode": "A String", # The read lock mode for the transaction. }, }, "id": "A String", # Execute the read or SQL query in a previously-started transaction. @@ -1746,7 +1746,7 @@

Method Details

}, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. "multiplexedSessionPreviousTransactionId": "A String", # Optional. Clients should pass the transaction ID of the previous transaction attempt that was aborted if this transaction is being executed on a multiplexed session. - "readLockMode": "A String", # Read lock mode for the transaction. + "readLockMode": "A String", # The read lock mode for the transaction. }, }, }, @@ -1959,7 +1959,7 @@

Method Details

}, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. "multiplexedSessionPreviousTransactionId": "A String", # Optional. Clients should pass the transaction ID of the previous transaction attempt that was aborted if this transaction is being executed on a multiplexed session. - "readLockMode": "A String", # Read lock mode for the transaction. + "readLockMode": "A String", # The read lock mode for the transaction. }, }, "id": "A String", # Execute the read or SQL query in a previously-started transaction. @@ -1978,7 +1978,7 @@

Method Details

}, "readWrite": { # Message type to initiate a read-write transaction. Currently this transaction type has no options. # Transaction may write. Authorization to begin a read-write transaction requires `spanner.databases.beginOrRollbackReadWriteTransaction` permission on the `session` resource. "multiplexedSessionPreviousTransactionId": "A String", # Optional. Clients should pass the transaction ID of the previous transaction attempt that was aborted if this transaction is being executed on a multiplexed session. - "readLockMode": "A String", # Read lock mode for the transaction. + "readLockMode": "A String", # The read lock mode for the transaction. }, }, }, diff --git a/docs/dyn/workloadmanager_v1.projects.locations.html b/docs/dyn/workloadmanager_v1.projects.locations.html index d953cc766a..6d7c6853d3 100644 --- a/docs/dyn/workloadmanager_v1.projects.locations.html +++ b/docs/dyn/workloadmanager_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/workspaceevents_v1.subscriptions.html b/docs/dyn/workspaceevents_v1.subscriptions.html
index f017531b36..12108042c4 100644
--- a/docs/dyn/workspaceevents_v1.subscriptions.html
+++ b/docs/dyn/workspaceevents_v1.subscriptions.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

create(body=None, validateOnly=None, x__xgafv=None)

-

Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can create a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

+

Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can create a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

delete(name, allowMissing=None, etag=None, validateOnly=None, x__xgafv=None)

Deletes a Google Workspace subscription. To learn how to use this method, see [Delete a Google Workspace subscription](https://developers.google.com/workspace/events/guides/delete-subscription).

@@ -94,10 +94,10 @@

Instance Methods

Retrieves the next page of results.

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

-

Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can update a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` andgetting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

+

Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can update a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

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

-

Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can reactivate a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` andgetting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

+

Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can reactivate a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

Method Details

close() @@ -106,7 +106,7 @@

Method Details

create(body=None, validateOnly=None, x__xgafv=None) -
Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can create a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+  
Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can create a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
 
 Args:
   body: object, The request body.
@@ -129,14 +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). + "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 created this subscription. Format: `projects/{project_id}/serviceAccounts/{service_account_id}` "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). + "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}` } validateOnly: boolean, Optional. If set to `true`, validates and previews the request, but doesn't create the subscription. @@ -238,14 +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). + "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 created this subscription. Format: `projects/{project_id}/serviceAccounts/{service_account_id}` "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). + "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}` }
@@ -285,14 +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). + "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 created this subscription. Format: `projects/{project_id}/serviceAccounts/{service_account_id}` "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). + "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}` }, ], }
@@ -314,7 +314,7 @@

Method Details

patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None) -
Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can update a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` andgetting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+  
Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can update a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
 
 Args:
   name: string, Identifier. Resource name of the subscription. Format: `subscriptions/{subscription}` (required)
@@ -338,14 +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). + "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 created this subscription. Format: `projects/{project_id}/serviceAccounts/{service_account_id}` "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). + "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}` } 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. @@ -381,7 +381,7 @@

Method Details

reactivate(name, body=None, x__xgafv=None) -
Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can reactivate a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` andgetting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
+  
Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can reactivate a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
 
 Args:
   name: string, Required. Resource name of the subscription. Format: `subscriptions/{subscription}` (required)
diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.html
index 0d8b02b1f0..14ba3506d8 100644
--- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.html
+++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.html
@@ -162,6 +162,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. } validateOnly: boolean, Optional. If set, validate the request and preview the result, but do not actually apply it. @@ -294,6 +296,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. }
@@ -367,6 +371,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. }, ], }
@@ -442,6 +448,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. } 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. diff --git a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json index 3b5e3cae2a..93cb44d71c 100644 --- a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json @@ -423,7 +423,7 @@ } } }, -"revision": "20260323", +"revision": "20260406", "rootUrl": "https://alertcenter.googleapis.com/", "schemas": { "AbuseDetected": { @@ -1948,7 +1948,8 @@ "CHAT_ATTACHMENT_UPLOADED", "CHROME_PAGE_PRINT", "CHROME_URL_VISITED", -"CHROMEOS_FILE_TRANSFER" +"CHROMEOS_FILE_TRANSFER", +"GEMINI_ACCESS" ], "enumDescriptions": [ "Trigger is unspecified.", @@ -1961,7 +1962,8 @@ "A Chat attachment is uploaded.", "A page is being printed by Chrome.", "A URL is visited within Chrome.", -"A file being transferred (copy or moved) between different file systems on ChromeOS." +"A file being transferred (copy or moved) between different file systems on ChromeOS.", +"Gemini access." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1.json index ac21949b3a..af028e642e 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1.json @@ -1247,7 +1247,7 @@ } } }, -"revision": "20260308", +"revision": "20260406", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AIInference": { @@ -1888,7 +1888,7 @@ "additionalProperties": { "type": "string" }, -"description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", +"description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\" See https://{$universe.dns_names.final_documentation_domain}/pubsub/docs/tags for more information on using tags with Pub/Sub resources.", "type": "object" } }, diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index 04c9e724f2..00acd7f02a 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1265,7 +1265,7 @@ } } }, -"revision": "20260323", +"revision": "20260408", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -6274,7 +6274,7 @@ false "ENTERPRISE_DISPLAY_NAME_HIDDEN" ], "enumDescriptions": [ -"Unspecified. Defaults to displaying the enterprise name that's set at the time of device setup. In future, this will default to ENTERPRISE_DISPLAY_NAME_VISIBLE.", +"Unspecified. Defaults to ENTERPRISE_DISPLAY_NAME_VISIBLE.", "The enterprise display name is visible on the device. Supported on work profiles on Android 7 and above. Supported on fully managed devices on Android 8 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 7. A NonComplianceDetail with MANAGEMENT_MODE is reported on fully managed devices on Android 7.", "The enterprise display name is hidden on the device." ], diff --git a/googleapiclient/discovery_cache/documents/apihub.v1.json b/googleapiclient/discovery_cache/documents/apihub.v1.json index c5a7028c9f..ddf2542457 100644 --- a/googleapiclient/discovery_cache/documents/apihub.v1.json +++ b/googleapiclient/discovery_cache/documents/apihub.v1.json @@ -210,7 +210,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": "apihub.projects.locations.list", @@ -3254,7 +3254,7 @@ } } }, -"revision": "20260311", +"revision": "20260406", "rootUrl": "https://apihub.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json index 25c6eb627c..8cc0cb61b2 100644 --- a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json +++ b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json @@ -169,7 +169,7 @@ ], "parameters": { "filter": { -"description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus", +"description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus * readyToServe", "location": "query", "type": "string" }, @@ -855,7 +855,7 @@ ], "parameters": { "filter": { -"description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus", +"description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus * readyToServe", "location": "query", "type": "string" }, @@ -1395,7 +1395,7 @@ } } }, -"revision": "20251211", +"revision": "20260409", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { diff --git a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json index a88295404d..de45302855 100644 --- a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json @@ -169,7 +169,7 @@ ], "parameters": { "filter": { -"description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus", +"description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus * readyToServe", "location": "query", "type": "string" }, @@ -1038,7 +1038,7 @@ ], "parameters": { "filter": { -"description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus", +"description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus * readyToServe", "location": "query", "type": "string" }, @@ -1806,7 +1806,7 @@ } } }, -"revision": "20251211", +"revision": "20260409", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1.json index 7ff006e3b9..831a746920 100644 --- a/googleapiclient/discovery_cache/documents/beyondcorp.v1.json +++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1.json @@ -271,7 +271,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": "beyondcorp.projects.locations.list", @@ -343,7 +343,7 @@ "type": "string" }, "requestId": { -"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the 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" }, @@ -381,7 +381,7 @@ "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).", +"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 the 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" }, @@ -523,7 +523,7 @@ "type": "string" }, "requestId": { -"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the 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" }, @@ -1652,7 +1652,7 @@ "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 request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.", +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.", "location": "query", "type": "string" } @@ -1909,7 +1909,7 @@ } } }, -"revision": "20260228", +"revision": "20260401", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -2170,7 +2170,7 @@ "type": "object" }, "GoogleCloudBeyondcorpAppconnectionsV1AppConnection": { -"description": "A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorised for a single AppConnection.", +"description": "A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorized for a single AppConnection.", "id": "GoogleCloudBeyondcorpAppconnectionsV1AppConnection", "properties": { "applicationEndpoint": { @@ -2178,7 +2178,7 @@ "description": "Required. Address of the remote application endpoint for the BeyondCorp AppConnection." }, "connectors": { -"description": "Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection.", +"description": "Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorized to be associated with this AppConnection.", "items": { "type": "string" }, @@ -2764,7 +2764,7 @@ "type": "object" }, "GoogleCloudBeyondcorpAppconnectorsV1ResourceInfo": { -"description": "ResourceInfo represents the information/status of an app connector resource. Such as: - remote_agent - container - runtime - appgateway - appconnector - appconnection - tunnel - logagent", +"description": "ResourceInfo represents the information or status of an app connector resource component that's used to report on various parts of the system. For example, ResourceInfo can be used to convey the status of a remote_agent, including the status of an appgateway for an runtime environment in a container instance.", "id": "GoogleCloudBeyondcorpAppconnectorsV1ResourceInfo", "properties": { "id": { @@ -3653,7 +3653,7 @@ "properties": { "apiGateway": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGateway", -"description": "Required. External API configuration." +"description": "Optional. External API configuration." } }, "type": "object" @@ -3664,7 +3664,7 @@ "properties": { "resourceOverride": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGatewayOperationDescriptor", -"description": "Required. Enables fetching resource model updates to alter service behavior per Chrome profile." +"description": "Optional. Enables fetching resource model updates to alter service behavior per Chrome profile." } }, "type": "object" @@ -3674,7 +3674,7 @@ "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ServiceDiscoveryApiGatewayOperationDescriptor", "properties": { "path": { -"description": "Required. Contains the URI path fragment where HTTP request is sent.", +"description": "Optional. Contains the URI path fragment where HTTP request is sent.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json index 7a37d9eab5..867a01ee61 100644 --- a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json @@ -673,7 +673,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": "beyondcorp.projects.locations.list", @@ -745,7 +745,7 @@ "type": "string" }, "requestId": { -"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the 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" }, @@ -783,7 +783,7 @@ "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).", +"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 the 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" }, @@ -925,7 +925,7 @@ "type": "string" }, "requestId": { -"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the 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" }, @@ -3075,7 +3075,7 @@ "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 request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.", +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.", "location": "query", "type": "string" } @@ -3332,7 +3332,7 @@ } } }, -"revision": "20260228", +"revision": "20260401", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -4009,7 +4009,7 @@ "type": "object" }, "GoogleCloudBeyondcorpAppconnectionsV1alphaAppConnection": { -"description": "A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorised for a single AppConnection.", +"description": "A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. Multiple connectors can be authorized for a single AppConnection.", "id": "GoogleCloudBeyondcorpAppconnectionsV1alphaAppConnection", "properties": { "applicationEndpoint": { @@ -4017,7 +4017,7 @@ "description": "Required. Address of the remote application endpoint for the BeyondCorp AppConnection." }, "connectors": { -"description": "Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection.", +"description": "Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorized to be associated with this AppConnection.", "items": { "type": "string" }, @@ -4635,7 +4635,7 @@ "type": "object" }, "GoogleCloudBeyondcorpAppconnectorsV1alphaResourceInfo": { -"description": "ResourceInfo represents the information/status of an app connector resource. Such as: - remote_agent - container - runtime - appgateway - appconnector - appconnection - tunnel - logagent", +"description": "ResourceInfo represents the information or status of an app connector resource component that's used to report on various parts of the system. For example, ResourceInfo can be used to convey the status of a remote_agent, including the status of an appgateway for an runtime environment in a container instance.", "id": "GoogleCloudBeyondcorpAppconnectorsV1alphaResourceInfo", "properties": { "id": { @@ -5809,7 +5809,7 @@ "properties": { "apiGateway": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscoveryApiGateway", -"description": "Required. External API configuration." +"description": "Optional. External API configuration." } }, "type": "object" @@ -5820,7 +5820,7 @@ "properties": { "resourceOverride": { "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscoveryApiGatewayOperationDescriptor", -"description": "Required. Enables fetching resource model updates to alter service behavior per Chrome profile." +"description": "Optional. Enables fetching resource model updates to alter service behavior per Chrome profile." } }, "type": "object" @@ -5830,7 +5830,7 @@ "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaServiceDiscoveryApiGatewayOperationDescriptor", "properties": { "path": { -"description": "Required. Contains the URI path fragment where HTTP request is sent.", +"description": "Optional. Contains the URI path fragment where HTTP request is sent.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json index ba569078ad..5f10076b91 100644 --- a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +++ b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json @@ -1087,7 +1087,7 @@ ], "parameters": { "filter": { -"description": "Optional. Filter for the transfer resources. Currently supported filters include: * Resource name: `name` - Wildcard supported * Resource type: `type` * Resource destination: `destination` * Latest resource state: `latest_status_detail.state` * Last update time: `update_time` - RFC-3339 format * Parent table name: `hierarchy_detail.partition_detail.table` Multiple filters can be applied using the `AND/OR` operator. Examples: * `name=\"*123\" AND (type=\"TABLE\" OR latest_status_detail.state=\"SUCCEEDED\")` * `update_time >= \"2012-04-21T11:30:00-04:00` * `hierarchy_detail.partition_detail.table = \"table1\"`", +"description": "Optional. Filter for the transfer resources. Currently supported filters include: * Resource name: `name` - Wildcard supported * Resource type: `type` * Resource destination: `destination` * Latest resource state: `latest_status_detail.state` * Last update time: `update_time` - RFC-3339 format * Parent table name: `hierarchy_detail.partition_detail.table` Multiple filters can be applied using the `AND/OR` operator. Examples: * `name=\"*123\" AND (type=\"TABLE\" OR latest_status_detail.state=\"SUCCEEDED\")` * `update_time >= \"2012-04-21T11:30:00-04:00\"` * `hierarchy_detail.partition_detail.table = \"table1\"`", "location": "query", "type": "string" }, @@ -1103,7 +1103,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of transfer configuration for which transfer resources should be retrieved. The name should be in one of the following form: * `projects/{project_id}/transferConfigs/{config_id}` * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", +"description": "Required. Name of transfer configuration for which transfer resources should be retrieved. The name should be in one of the following forms: * `projects/{project}/transferConfigs/{transfer_config}` * `projects/{project}/locations/{location_id}/transferConfigs/{transfer_config}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -1611,7 +1611,7 @@ ], "parameters": { "filter": { -"description": "Optional. Filter for the transfer resources. Currently supported filters include: * Resource name: `name` - Wildcard supported * Resource type: `type` * Resource destination: `destination` * Latest resource state: `latest_status_detail.state` * Last update time: `update_time` - RFC-3339 format * Parent table name: `hierarchy_detail.partition_detail.table` Multiple filters can be applied using the `AND/OR` operator. Examples: * `name=\"*123\" AND (type=\"TABLE\" OR latest_status_detail.state=\"SUCCEEDED\")` * `update_time >= \"2012-04-21T11:30:00-04:00` * `hierarchy_detail.partition_detail.table = \"table1\"`", +"description": "Optional. Filter for the transfer resources. Currently supported filters include: * Resource name: `name` - Wildcard supported * Resource type: `type` * Resource destination: `destination` * Latest resource state: `latest_status_detail.state` * Last update time: `update_time` - RFC-3339 format * Parent table name: `hierarchy_detail.partition_detail.table` Multiple filters can be applied using the `AND/OR` operator. Examples: * `name=\"*123\" AND (type=\"TABLE\" OR latest_status_detail.state=\"SUCCEEDED\")` * `update_time >= \"2012-04-21T11:30:00-04:00\"` * `hierarchy_detail.partition_detail.table = \"table1\"`", "location": "query", "type": "string" }, @@ -1627,7 +1627,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of transfer configuration for which transfer resources should be retrieved. The name should be in one of the following form: * `projects/{project_id}/transferConfigs/{config_id}` * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`", +"description": "Required. Name of transfer configuration for which transfer resources should be retrieved. The name should be in one of the following forms: * `projects/{project}/transferConfigs/{transfer_config}` * `projects/{project}/locations/{location_id}/transferConfigs/{transfer_config}`", "location": "path", "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", "required": true, @@ -1651,7 +1651,7 @@ } } }, -"revision": "20260320", +"revision": "20260406", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": { @@ -2044,7 +2044,7 @@ "type": "object" }, "ListTransferResourcesResponse": { -"description": "Response for the ListTransferResources RPC.", +"description": "Response for the `ListTransferResources` RPC.", "id": "ListTransferResourcesResponse", "properties": { "nextPageToken": { @@ -2476,7 +2476,7 @@ "type": "object" }, "TransferResource": { -"description": "Resource(table/partition) that is being transferred.", +"description": "Resource (table/partition) that is being transferred.", "id": "TransferResource", "properties": { "destination": { @@ -2691,7 +2691,7 @@ "id": "TransferRunBrief", "properties": { "run": { -"description": "Optional. Run URI. Format projects/{project}/locations/{location}/transferConfigs/{config}/run/{run}", +"description": "Optional. Run URI. The format must be: `projects/{project}/locations/{location}/transferConfigs/{transfer_config}/run/{run}`", "type": "string" }, "startTime": { diff --git a/googleapiclient/discovery_cache/documents/classroom.v1.json b/googleapiclient/discovery_cache/documents/classroom.v1.json index 6a27e848a7..58db2c6571 100644 --- a/googleapiclient/discovery_cache/documents/classroom.v1.json +++ b/googleapiclient/discovery_cache/documents/classroom.v1.json @@ -308,12 +308,12 @@ "type": "string" }, "studentId": { -"description": "Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user", +"description": "Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user If specified, `teacher_id` must be empty.", "location": "query", "type": "string" }, "teacherId": { -"description": "Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user", +"description": "Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user If specified, `student_id` must be empty.", "location": "query", "type": "string" } @@ -4366,7 +4366,7 @@ } } }, -"revision": "20260310", +"revision": "20260407", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "AddOnAttachment": { diff --git a/googleapiclient/discovery_cache/documents/datalineage.v1.json b/googleapiclient/discovery_cache/documents/datalineage.v1.json index 53c253f573..959f3eb744 100644 --- a/googleapiclient/discovery_cache/documents/datalineage.v1.json +++ b/googleapiclient/discovery_cache/documents/datalineage.v1.json @@ -816,7 +816,7 @@ ], "parameters": { "allowMissing": { -"description": "If set to true and the process is not found, the request succeeds but the server doesn't perform any actions.", +"description": "Optional. If set to true and the process is not found, the request succeeds but the server doesn't perform any actions.", "location": "query", "type": "boolean" }, @@ -871,13 +871,13 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of processes to return. The service may return fewer than this value. If unspecified, at most 50 processes are returned. The maximum value is 100; values greater than 100 are cut to 100.", +"description": "Optional. The maximum number of processes to return. The service may return fewer than this value. If unspecified, at most 50 processes are returned. The maximum value is 100; values greater than 100 are cut to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The page token received from a previous `ListProcesses` call. Specify it to get the next page. When paginating, all other parameters specified in this call must match the parameters of the call that provided the page token.", +"description": "Optional. The page token received from a previous `ListProcesses` call. Specify it to get the next page. When paginating, all other parameters specified in this call must match the parameters of the call that provided the page token.", "location": "query", "type": "string" }, @@ -907,7 +907,7 @@ ], "parameters": { "allowMissing": { -"description": "If set to true and the process is not found, the request inserts it.", +"description": "Optional. If set to true and the process is not found, the request inserts it.", "location": "query", "type": "boolean" }, @@ -924,7 +924,7 @@ "type": "string" }, "updateMask": { -"description": "The list of fields to update. Currently not used. The whole message is updated.", +"description": "Optional. The list of fields to update. Currently not used. The whole message is updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -988,7 +988,7 @@ ], "parameters": { "allowMissing": { -"description": "If set to true and the run is not found, the request succeeds but the server doesn't perform any actions.", +"description": "Optional. If set to true and the run is not found, the request succeeds but the server doesn't perform any actions.", "location": "query", "type": "boolean" }, @@ -1043,13 +1043,13 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of runs to return. The service may return fewer than this value. If unspecified, at most 50 runs are returned. The maximum value is 100; values greater than 100 are cut to 100.", +"description": "Optional. The maximum number of runs to return. The service may return fewer than this value. If unspecified, at most 50 runs are returned. The maximum value is 100; values greater than 100 are cut to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The page token received from a previous `ListRuns` call. Specify it to get the next page. When paginating, all other parameters specified in this call must match the parameters of the call that provided the page token.", +"description": "Optional. The page token received from a previous `ListRuns` call. Specify it to get the next page. When paginating, all other parameters specified in this call must match the parameters of the call that provided the page token.", "location": "query", "type": "string" }, @@ -1079,7 +1079,7 @@ ], "parameters": { "allowMissing": { -"description": "If set to true and the run is not found, the request creates it.", +"description": "Optional. If set to true and the run is not found, the request creates it.", "location": "query", "type": "boolean" }, @@ -1091,7 +1091,7 @@ "type": "string" }, "updateMask": { -"description": "The list of fields to update. Currently not used. The whole message is updated.", +"description": "Optional. The list of fields to update. Currently not used. The whole message is updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1155,7 +1155,7 @@ ], "parameters": { "allowMissing": { -"description": "If set to true and the lineage event is not found, the request succeeds but the server doesn't perform any actions.", +"description": "Optional. If set to true and the lineage event is not found, the request succeeds but the server doesn't perform any actions.", "location": "query", "type": "boolean" }, @@ -1210,13 +1210,13 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of lineage events to return. The service may return fewer events than this value. If unspecified, at most 50 events are returned. The maximum value is 100; values greater than 100 are cut to 100.", +"description": "Optional. The maximum number of lineage events to return. The service may return fewer events than this value. If unspecified, at most 50 events are returned. The maximum value is 100; values greater than 100 are cut to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The page token received from a previous `ListLineageEvents` call. Specify it to get the next page. When paginating, all other parameters specified in this call must match the parameters of the call that provided the page token.", +"description": "Optional. The page token received from a previous `ListLineageEvents` call. Specify it to get the next page. When paginating, all other parameters specified in this call must match the parameters of the call that provided the page token.", "location": "query", "type": "string" }, @@ -1247,7 +1247,7 @@ } } }, -"revision": "20260313", +"revision": "20260406", "rootUrl": "https://datalineage.googleapis.com/", "schemas": { "GoogleCloudDatacatalogLineageConfigmanagementV1Config": { diff --git a/googleapiclient/discovery_cache/documents/dns.v1.json b/googleapiclient/discovery_cache/documents/dns.v1.json index dd0f3ed154..a86dc1d268 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1.json +++ b/googleapiclient/discovery_cache/documents/dns.v1.json @@ -1225,7 +1225,7 @@ ], "parameters": { "filter": { -"description": "Specify a filter expression to view records that exactly match the specified domain. Both the name and type parameters are not supported when you use filter and must be omitted. Your filter expression must conform to AIP-160 and you must specify a domain in the name field. Optionally, you can include the type field to filter records by type. You can also include the has_suffix function to view records that match by domain suffix. Examples: - name=\"example.com.\" - name=\"example.com.\" AND type=\"A\" - name=has_suffix(\"example.com.\") - name=has_suffix(\"example.com.\") AND type=\"A\" ", +"description": "Specify a filter expression to view records that exactly match the specified domain. Both the `name` and `type` parameters are not supported and must be omitted when you use `filter`. Your `filter` expression must conform to AIP-160 and you must specify a domain in the `name` field. Optionally, you can include the `type` field to filter records by type. You can also include the `has_suffix` function to view records that match by domain suffix. Examples: * `name`=\"example.com.\" * `name`=\"example.com.\" AND type=\"A\" * `name`=`has_suffix`(\"example.com.\") * `name`=`has_suffix`(\"example.com.\") AND type=\"A\"", "location": "query", "type": "string" }, @@ -1242,7 +1242,7 @@ "type": "integer" }, "name": { -"description": "Specify a fully qualified domain name to view only those records. The name parameter is not supported and must be omitted when you use filter.", +"description": "Specify a fully qualified domain name to view only those records. The `name` parameter is not supported and must be omitted when you use `filter`.", "location": "query", "type": "string" }, @@ -1258,7 +1258,7 @@ "type": "string" }, "type": { -"description": "Specify a record type to view only those records. You must also specify the name parameter. The type parameter is not supported and must be omitted when you use filter.", +"description": "Specify a record type to view only those records. You must also specify the `name` parameter. The `type` parameter is not supported and must be omitted when you use `filter`.", "location": "query", "type": "string" } @@ -1829,7 +1829,7 @@ } } }, -"revision": "20260219", +"revision": "20260402", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { diff --git a/googleapiclient/discovery_cache/documents/dns.v1beta2.json b/googleapiclient/discovery_cache/documents/dns.v1beta2.json index bb3091b3a0..f24225d882 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/dns.v1beta2.json @@ -1222,7 +1222,7 @@ ], "parameters": { "filter": { -"description": "Specify a filter expression to view records that exactly match the specified domain. Both the name and type parameters are not supported when you use filter and must be omitted. Your filter expression must conform to AIP-160 and you must specify a domain in the name field. Optionally, you can include the type field to filter records by type. You can also include the has_suffix function to view records that match by domain suffix. Examples: - name=\"example.com.\" - name=\"example.com.\" AND type=\"A\" - name=has_suffix(\"example.com.\") - name=has_suffix(\"example.com.\") AND type=\"A\" ", +"description": "Specify a filter expression to view records that exactly match the specified domain. Both the `name` and `type` parameters are not supported and must be omitted when you use `filter`. Your `filter` expression must conform to AIP-160 and you must specify a domain in the `name` field. Optionally, you can include the `type` field to filter records by type. You can also include the `has_suffix` function to view records that match by domain suffix. Examples: * `name`=\"example.com.\" * `name`=\"example.com.\" AND type=\"A\" * `name`=`has_suffix`(\"example.com.\") * `name`=`has_suffix`(\"example.com.\") AND type=\"A\"", "location": "query", "type": "string" }, @@ -1239,7 +1239,7 @@ "type": "integer" }, "name": { -"description": "Specify a fully qualified domain name to view only those records. The name parameter is not supported and must be omitted when you use filter.", +"description": "Specify a fully qualified domain name to view only those records. The `name` parameter is not supported and must be omitted when you use `filter`.", "location": "query", "type": "string" }, @@ -1255,7 +1255,7 @@ "type": "string" }, "type": { -"description": "Specify a record type to view only those records. You must also specify the name parameter. The type parameter is not supported and must be omitted when you use filter.", +"description": "Specify a record type to view only those records. You must also specify the `name` parameter. The `type` parameter is not supported and must be omitted when you use `filter`.", "location": "query", "type": "string" } @@ -1826,7 +1826,7 @@ } } }, -"revision": "20260219", +"revision": "20260402", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index 0f72d587be..eab6a133b4 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20260405", +"revision": "20260408", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -1364,13 +1364,15 @@ "MODALITY_UNSPECIFIED", "TEXT", "IMAGE", -"AUDIO" +"AUDIO", +"VIDEO" ], "enumDescriptions": [ "Unspecified modality. Will be processed as text.", "Text modality.", "Image modality.", -"Audio modality." +"Audio modality.", +"Video modality." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/monitoring.v1.json b/googleapiclient/discovery_cache/documents/monitoring.v1.json index 866b4ad8e8..b023c88470 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v1.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v1.json @@ -753,7 +753,7 @@ } } }, -"revision": "20260302", +"revision": "20260402", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -1258,7 +1258,7 @@ "type": "array" }, "minAlignmentPeriod": { -"description": "Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.", +"description": "Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step.", "format": "google-duration", "type": "string" }, @@ -2362,7 +2362,7 @@ "id": "SparkChartView", "properties": { "minAlignmentPeriod": { -"description": "The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.", +"description": "The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step.", "format": "google-duration", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json index db0bde5da1..31498b4681 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json @@ -612,7 +612,7 @@ } } }, -"revision": "20260405", +"revision": "20260412", "rootUrl": "https://mybusinessbusinessinformation.googleapis.com/", "schemas": { "AdWordsLocationExtensions": { @@ -1124,7 +1124,7 @@ }, "profile": { "$ref": "Profile", -"description": "Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g. hotels, motels, inns)." +"description": "Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns)." }, "regularHours": { "$ref": "BusinessHours", @@ -1500,7 +1500,7 @@ "enumDescriptions": [ "Type unspecified.", "This represents a relation between 2 locations which share one physical area, same brand/upper management/organization, but with different key attributes like store hours or phone numbers. For example, Costco Pharmacy is a department in Costco Wholesale.", -"This represents the cases where 2 locations are co-located in the same physical location, but from different companies (e.g. Starbucks in a Safeway, shops in a mall)." +"This represents the cases where 2 locations are co-located in the same physical location, but from different companies (e.g., Starbucks in a Safeway, shops in a mall)." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1.json index 6bba2b416e..7af7aa4eb3 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1.json @@ -5237,7 +5237,7 @@ } } }, -"revision": "20260323", +"revision": "20260407", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -5863,7 +5863,7 @@ "id": "AuthzPolicyTarget", "properties": { "loadBalancingScheme": { -"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).", +"description": "Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. 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", @@ -5879,7 +5879,7 @@ "type": "string" }, "resources": { -"description": "Required. A list of references to the Forwarding Rules on which this policy will be applied.", +"description": "Required. A list of references to the Forwarding Rules, Secure Web Proxy Gateways, or Agent Gateways on which this policy will be applied.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json index 8b5a83bfd7..d644c17436 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json @@ -5523,7 +5523,7 @@ } } }, -"revision": "20260323", +"revision": "20260407", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -6149,7 +6149,7 @@ "id": "AuthzPolicyTarget", "properties": { "loadBalancingScheme": { -"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).", +"description": "Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. 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", @@ -6165,7 +6165,7 @@ "type": "string" }, "resources": { -"description": "Required. A list of references to the Forwarding Rules on which this policy will be applied.", +"description": "Required. A list of references to the Forwarding Rules, Secure Web Proxy Gateways, or Agent Gateways on which this policy will be applied.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/notebooks.v1.json b/googleapiclient/discovery_cache/documents/notebooks.v1.json index ef5972aa82..0011252103 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v1.json +++ b/googleapiclient/discovery_cache/documents/notebooks.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": "notebooks.projects.locations.list", @@ -2019,7 +2019,7 @@ } } }, -"revision": "20260130", +"revision": "20260401", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { diff --git a/googleapiclient/discovery_cache/documents/notebooks.v2.json b/googleapiclient/discovery_cache/documents/notebooks.v2.json index 49f9a586db..965d695607 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v2.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v2.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": "v2/projects/{projectsId}/locations", "httpMethod": "GET", "id": "notebooks.projects.locations.list", @@ -971,7 +971,7 @@ } } }, -"revision": "20260130", +"revision": "20260401", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1088,7 +1088,11 @@ "PD_SSD", "PD_BALANCED", "PD_EXTREME", -"HYPERDISK_BALANCED" +"HYPERDISK_BALANCED", +"HYPERDISK_EXTREME", +"HYPERDISK_THROUGHPUT", +"HYPERDISK_BALANCED_HIGH_AVAILABILITY", +"HYPERDISK_ML" ], "enumDescriptions": [ "Disk type not set.", @@ -1096,7 +1100,11 @@ "SSD persistent disk type.", "Balanced persistent disk type.", "Extreme persistent disk type.", -"Hyperdisk Balanced persistent disk type." +"Represents the Hyperdisk Balanced persistent disk type. Can be used as a boot disk or data disk.", +"Represents the Hyperdisk Extreme persistent disk type. Can only be used as a data disk.", +"Represents the Hyperdisk Throughput persistent disk type. Can only be used as a data disk.", +"Represents the Hyperdisk Balanced High Availability persistent disk type. Can be used as a boot disk or data disk.", +"Represents the Hyperdisk ML persistent disk type. Can be used as a boot disk or data disk." ], "type": "string" }, @@ -1266,7 +1274,11 @@ "PD_SSD", "PD_BALANCED", "PD_EXTREME", -"HYPERDISK_BALANCED" +"HYPERDISK_BALANCED", +"HYPERDISK_EXTREME", +"HYPERDISK_THROUGHPUT", +"HYPERDISK_BALANCED_HIGH_AVAILABILITY", +"HYPERDISK_ML" ], "enumDescriptions": [ "Disk type not set.", @@ -1274,7 +1286,11 @@ "SSD persistent disk type.", "Balanced persistent disk type.", "Extreme persistent disk type.", -"Hyperdisk Balanced persistent disk type." +"Represents the Hyperdisk Balanced persistent disk type. Can be used as a boot disk or data disk.", +"Represents the Hyperdisk Extreme persistent disk type. Can only be used as a data disk.", +"Represents the Hyperdisk Throughput persistent disk type. Can only be used as a data disk.", +"Represents the Hyperdisk Balanced High Availability persistent disk type. Can be used as a boot disk or data disk.", +"Represents the Hyperdisk ML persistent disk type. Can be used as a boot disk or data disk." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index 242b24fb2e..e9f1745e9d 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -786,7 +786,7 @@ } } }, -"revision": "20260322", +"revision": "20260405", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -2268,7 +2268,9 @@ true "DUPE", "MISSING", "BROWSER_ERROR", -"UNEXPECTED_ACTION" +"UNEXPECTED_ACTION", +"KEY_MISMATCH", +"DOMAIN_MISMATCH" ], "enumDescriptions": [ "Default unspecified type.", @@ -2278,7 +2280,9 @@ true "The user verification had already been seen.", "The user verification token was not present.", "A retriable error (such as network failure) occurred on the browser. Could easily be simulated by an attacker.", -"The action provided at token generation was different than the `expected_action` in the assessment request. The comparison is case-insensitive. This reason can only be returned if all of the following are true: - your `site_key` has the POLICY_BASED_CHALLENGE integration type - you set an action score threshold higher than 0.0 - you provided a non-empty `expected_action`" +"The action provided at token generation was different than the `expected_action` in the assessment request. The comparison is case-insensitive. This reason can only be returned if all of the following are true: - your `site_key` has the POLICY_BASED_CHALLENGE integration type - you set an action score threshold higher than 0.0 - you provided a non-empty `expected_action`", +"The key used to generate the token does not match the `site_key`.", +"The domain of the page on which the token was generated does not match the `allowed_domains` configured in the `site_key`." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index fb24ac80ac..32e100db76 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -336,7 +336,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. The `next_page_token` value returned from a previous ListAclPolicies request, if any.", +"description": "Optional. The `next_page_token` value returned from a previous `ListAclPolicies` request, if any.", "location": "query", "type": "string" }, @@ -379,7 +379,7 @@ "type": "string" }, "updateMask": { -"description": "Optional. Mask of fields to be updated. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from AclPolicy: * `rules`", +"description": "Optional. Mask of fields to be updated. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from `AclPolicy`: * `rules`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -797,7 +797,7 @@ "type": "integer" }, "pageToken": { -"description": "The `next_page_token` value returned from a previous ListClusters request, if any.", +"description": "The `next_page_token` value returned from a previous `ListClusters` request, if any.", "location": "query", "type": "string" }, @@ -1608,7 +1608,7 @@ } } }, -"revision": "20260331", +"revision": "20260406", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1895,14 +1895,20 @@ "REDIS_SHARED_CORE_NANO", "REDIS_HIGHMEM_MEDIUM", "REDIS_HIGHMEM_XLARGE", -"REDIS_STANDARD_SMALL" +"REDIS_STANDARD_SMALL", +"REDIS_HIGHCPU_MEDIUM", +"REDIS_STANDARD_LARGE", +"REDIS_HIGHMEM_2XLARGE" ], "enumDescriptions": [ "Node type unspecified", "Redis shared core nano node_type.", "Redis highmem medium node_type.", "Redis highmem xlarge node_type.", -"Redis standard small node_type." +"Redis standard small node_type.", +"Redis highcpu medium node_type.", +"Redis standard large node_type.", +"Redis highmem 2xlarge node_type." ], "readOnly": true, "type": "string" @@ -1953,7 +1959,7 @@ "type": "object" }, "BackupClusterRequest": { -"description": "Request for [BackupCluster].", +"description": "Request for `BackupCluster`.", "id": "BackupClusterRequest", "properties": { "backupId": { @@ -2308,14 +2314,20 @@ "REDIS_SHARED_CORE_NANO", "REDIS_HIGHMEM_MEDIUM", "REDIS_HIGHMEM_XLARGE", -"REDIS_STANDARD_SMALL" +"REDIS_STANDARD_SMALL", +"REDIS_HIGHCPU_MEDIUM", +"REDIS_STANDARD_LARGE", +"REDIS_HIGHMEM_2XLARGE" ], "enumDescriptions": [ "Node type unspecified", "Redis shared core nano node_type.", "Redis highmem medium node_type.", "Redis highmem xlarge node_type.", -"Redis standard small node_type." +"Redis standard small node_type.", +"Redis highcpu medium node_type.", +"Redis standard large node_type.", +"Redis highmem 2xlarge node_type." ], "type": "string" }, @@ -4200,7 +4212,7 @@ false "type": "object" }, "ExportBackupRequest": { -"description": "Request for [ExportBackup].", +"description": "Request for `ExportBackup`.", "id": "ExportBackupRequest", "properties": { "gcsBucket": { @@ -4690,7 +4702,7 @@ false "type": "object" }, "ListAclPoliciesResponse": { -"description": "Response for ListAclPolicies.", +"description": "Response for `ListAclPolicies`.", "id": "ListAclPoliciesResponse", "properties": { "aclPolicies": { @@ -4740,7 +4752,7 @@ false "type": "object" }, "ListBackupCollectionsResponse": { -"description": "Response for [ListBackupCollections].", +"description": "Response for `ListBackupCollections`.", "id": "ListBackupCollectionsResponse", "properties": { "backupCollections": { @@ -4765,7 +4777,7 @@ false "type": "object" }, "ListBackupsResponse": { -"description": "Response for [ListBackups].", +"description": "Response for `ListBackups`.", "id": "ListBackupsResponse", "properties": { "backups": { @@ -4790,7 +4802,7 @@ false "type": "object" }, "ListClustersResponse": { -"description": "Response for ListClusters.", +"description": "Response for `ListClusters`.", "id": "ListClustersResponse", "properties": { "clusters": { @@ -6222,14 +6234,20 @@ false "REDIS_SHARED_CORE_NANO", "REDIS_HIGHMEM_MEDIUM", "REDIS_HIGHMEM_XLARGE", -"REDIS_STANDARD_SMALL" +"REDIS_STANDARD_SMALL", +"REDIS_HIGHCPU_MEDIUM", +"REDIS_STANDARD_LARGE", +"REDIS_HIGHMEM_2XLARGE" ], "enumDescriptions": [ "Node type unspecified", "Redis shared core nano node_type.", "Redis highmem medium node_type.", "Redis highmem xlarge node_type.", -"Redis standard small node_type." +"Redis standard small node_type.", +"Redis highcpu medium node_type.", +"Redis standard large node_type.", +"Redis highmem 2xlarge node_type." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index 1e8610826f..3760ac2790 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -336,7 +336,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. The `next_page_token` value returned from a previous ListAclPolicies request, if any.", +"description": "Optional. The `next_page_token` value returned from a previous `ListAclPolicies` request, if any.", "location": "query", "type": "string" }, @@ -379,7 +379,7 @@ "type": "string" }, "updateMask": { -"description": "Optional. Mask of fields to be updated. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from AclPolicy: * `rules`", +"description": "Optional. Mask of fields to be updated. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from `AclPolicy`: * `rules`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -793,7 +793,7 @@ "type": "integer" }, "pageToken": { -"description": "The `next_page_token` value returned from a previous ListClusters request, if any.", +"description": "The `next_page_token` value returned from a previous `ListClusters` request, if any.", "location": "query", "type": "string" }, @@ -1604,7 +1604,7 @@ } } }, -"revision": "20260331", +"revision": "20260406", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1891,14 +1891,20 @@ "REDIS_SHARED_CORE_NANO", "REDIS_HIGHMEM_MEDIUM", "REDIS_HIGHMEM_XLARGE", -"REDIS_STANDARD_SMALL" +"REDIS_STANDARD_SMALL", +"REDIS_HIGHCPU_MEDIUM", +"REDIS_STANDARD_LARGE", +"REDIS_HIGHMEM_2XLARGE" ], "enumDescriptions": [ "Node type unspecified", "Redis shared core nano node_type.", "Redis highmem medium node_type.", "Redis highmem xlarge node_type.", -"Redis standard small node_type." +"Redis standard small node_type.", +"Redis highcpu medium node_type.", +"Redis standard large node_type.", +"Redis highmem 2xlarge node_type." ], "readOnly": true, "type": "string" @@ -1949,7 +1955,7 @@ "type": "object" }, "BackupClusterRequest": { -"description": "Request for [BackupCluster].", +"description": "Request for `BackupCluster`.", "id": "BackupClusterRequest", "properties": { "backupId": { @@ -2304,14 +2310,20 @@ "REDIS_SHARED_CORE_NANO", "REDIS_HIGHMEM_MEDIUM", "REDIS_HIGHMEM_XLARGE", -"REDIS_STANDARD_SMALL" +"REDIS_STANDARD_SMALL", +"REDIS_HIGHCPU_MEDIUM", +"REDIS_STANDARD_LARGE", +"REDIS_HIGHMEM_2XLARGE" ], "enumDescriptions": [ "Node type unspecified", "Redis shared core nano node_type.", "Redis highmem medium node_type.", "Redis highmem xlarge node_type.", -"Redis standard small node_type." +"Redis standard small node_type.", +"Redis highcpu medium node_type.", +"Redis standard large node_type.", +"Redis highmem 2xlarge node_type." ], "type": "string" }, @@ -4196,7 +4208,7 @@ false "type": "object" }, "ExportBackupRequest": { -"description": "Request for [ExportBackup].", +"description": "Request for `ExportBackup`.", "id": "ExportBackupRequest", "properties": { "gcsBucket": { @@ -4693,7 +4705,7 @@ false "type": "object" }, "ListAclPoliciesResponse": { -"description": "Response for ListAclPolicies.", +"description": "Response for `ListAclPolicies`.", "id": "ListAclPoliciesResponse", "properties": { "aclPolicies": { @@ -4743,7 +4755,7 @@ false "type": "object" }, "ListBackupCollectionsResponse": { -"description": "Response for [ListBackupCollections].", +"description": "Response for `ListBackupCollections`.", "id": "ListBackupCollectionsResponse", "properties": { "backupCollections": { @@ -4768,7 +4780,7 @@ false "type": "object" }, "ListBackupsResponse": { -"description": "Response for [ListBackups].", +"description": "Response for `ListBackups`.", "id": "ListBackupsResponse", "properties": { "backups": { @@ -4793,7 +4805,7 @@ false "type": "object" }, "ListClustersResponse": { -"description": "Response for ListClusters.", +"description": "Response for `ListClusters`.", "id": "ListClustersResponse", "properties": { "clusters": { @@ -6225,14 +6237,20 @@ false "REDIS_SHARED_CORE_NANO", "REDIS_HIGHMEM_MEDIUM", "REDIS_HIGHMEM_XLARGE", -"REDIS_STANDARD_SMALL" +"REDIS_STANDARD_SMALL", +"REDIS_HIGHCPU_MEDIUM", +"REDIS_STANDARD_LARGE", +"REDIS_HIGHMEM_2XLARGE" ], "enumDescriptions": [ "Node type unspecified", "Redis shared core nano node_type.", "Redis highmem medium node_type.", "Redis highmem xlarge node_type.", -"Redis standard small node_type." +"Redis standard small node_type.", +"Redis highcpu medium node_type.", +"Redis standard large node_type.", +"Redis highmem 2xlarge node_type." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json index 9692602277..04df48aaf9 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json @@ -547,7 +547,7 @@ } } }, -"revision": "20260210", +"revision": "20260403", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -856,7 +856,7 @@ "type": "object" }, "pathTranslation": { -"description": "no-lint", +"description": "Path translation specifies how to combine the backend address with the request path in order to produce the appropriate forwarding URL for the request. See PathTranslation for more details.", "enum": [ "PATH_TRANSLATION_UNSPECIFIED", "CONSTANT_ADDRESS", @@ -1123,7 +1123,7 @@ }, "selectiveGapicGeneration": { "$ref": "SelectiveGapicGeneration", -"description": "Configuration for which RPCs should be generated in the GAPIC client." +"description": "Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases." } }, "type": "object" @@ -2676,7 +2676,7 @@ "type": "object" }, "SelectiveGapicGeneration": { -"description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", +"description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases.", "id": "SelectiveGapicGeneration", "properties": { "generateOmittedAsInternal": { @@ -2745,7 +2745,7 @@ "description": "Additional API documentation." }, "endpoints": { -"description": "Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. WARNING: Defining any entries in the `endpoints` list disables the automatic generation of default endpoint variations (e.g., `{service}.clients6.google.com`, `content-{service}.googleapis.com`, and mTLS variants like `{service}.mtls.googleapis.com`). To retain these default variations, you are required to explicitly include your main service endpoint (e.g., `myservice.googleapis.com`) in this list alongside any other custom endpoints (like REP, GFE, etc.).", +"description": "Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.", "items": { "$ref": "Endpoint" }, @@ -3190,7 +3190,7 @@ "id": "UsageRule", "properties": { "allowUnregisteredCalls": { -"description": " Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", +"description": "Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", "type": "boolean" }, "selector": { diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json index 14d01f4c70..50c770b4d7 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json @@ -724,7 +724,7 @@ } } }, -"revision": "20260210", +"revision": "20260403", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -984,7 +984,7 @@ "type": "object" }, "pathTranslation": { -"description": "no-lint", +"description": "Path translation specifies how to combine the backend address with the request path in order to produce the appropriate forwarding URL for the request. See PathTranslation for more details.", "enum": [ "PATH_TRANSLATION_UNSPECIFIED", "CONSTANT_ADDRESS", @@ -1234,7 +1234,7 @@ }, "selectiveGapicGeneration": { "$ref": "SelectiveGapicGeneration", -"description": "Configuration for which RPCs should be generated in the GAPIC client." +"description": "Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases." } }, "type": "object" @@ -2675,7 +2675,7 @@ "type": "object" }, "SelectiveGapicGeneration": { -"description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", +"description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases.", "id": "SelectiveGapicGeneration", "properties": { "generateOmittedAsInternal": { @@ -2744,7 +2744,7 @@ "description": "Additional API documentation." }, "endpoints": { -"description": "Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. WARNING: Defining any entries in the `endpoints` list disables the automatic generation of default endpoint variations (e.g., `{service}.clients6.google.com`, `content-{service}.googleapis.com`, and mTLS variants like `{service}.mtls.googleapis.com`). To retain these default variations, you are required to explicitly include your main service endpoint (e.g., `myservice.googleapis.com`) in this list alongside any other custom endpoints (like REP, GFE, etc.).", +"description": "Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.", "items": { "$ref": "Endpoint" }, @@ -3034,7 +3034,7 @@ "id": "UsageRule", "properties": { "allowUnregisteredCalls": { -"description": " Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", +"description": "Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", "type": "boolean" }, "selector": { diff --git a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json index 4c61e96e46..7364c92196 100644 --- a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json @@ -835,7 +835,7 @@ } } }, -"revision": "20260219", +"revision": "20260406", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -1154,7 +1154,7 @@ "type": "object" }, "pathTranslation": { -"description": "no-lint", +"description": "Path translation specifies how to combine the backend address with the request path in order to produce the appropriate forwarding URL for the request. See PathTranslation for more details.", "enum": [ "PATH_TRANSLATION_UNSPECIFIED", "CONSTANT_ADDRESS", @@ -1440,7 +1440,7 @@ }, "selectiveGapicGeneration": { "$ref": "SelectiveGapicGeneration", -"description": "Configuration for which RPCs should be generated in the GAPIC client." +"description": "Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases." } }, "type": "object" @@ -3374,7 +3374,7 @@ "type": "object" }, "SelectiveGapicGeneration": { -"description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", +"description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases.", "id": "SelectiveGapicGeneration", "properties": { "generateOmittedAsInternal": { @@ -3443,7 +3443,7 @@ "description": "Additional API documentation." }, "endpoints": { -"description": "Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. WARNING: Defining any entries in the `endpoints` list disables the automatic generation of default endpoint variations (e.g., `{service}.clients6.google.com`, `content-{service}.googleapis.com`, and mTLS variants like `{service}.mtls.googleapis.com`). To retain these default variations, you are required to explicitly include your main service endpoint (e.g., `myservice.googleapis.com`) in this list alongside any other custom endpoints (like REP, GFE, etc.).", +"description": "Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.", "items": { "$ref": "Endpoint" }, @@ -3860,7 +3860,7 @@ "id": "UsageRule", "properties": { "allowUnregisteredCalls": { -"description": " Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", +"description": "Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", "type": "boolean" }, "selector": { diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json index 0df6389894..a9d9a40239 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json @@ -1034,7 +1034,7 @@ } } }, -"revision": "20260223", +"revision": "20260406", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1495,7 +1495,7 @@ "type": "object" }, "pathTranslation": { -"description": "no-lint", +"description": "Path translation specifies how to combine the backend address with the request path in order to produce the appropriate forwarding URL for the request. See PathTranslation for more details.", "enum": [ "PATH_TRANSLATION_UNSPECIFIED", "CONSTANT_ADDRESS", @@ -1777,7 +1777,7 @@ }, "selectiveGapicGeneration": { "$ref": "SelectiveGapicGeneration", -"description": "Configuration for which RPCs should be generated in the GAPIC client." +"description": "Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases." } }, "type": "object" @@ -3523,7 +3523,8 @@ "STREET_VIEW", "SHOPPING", "GEO", -"GENERATIVE_AI" +"GENERATIVE_AI", +"HEALTH" ], "enumDescriptions": [ "Not useful.", @@ -3533,7 +3534,8 @@ "Street View Org.", "Shopping Org.", "Geo Org.", -"Generative AI - https://developers.generativeai.google" +"Generative AI - https://developers.generativeai.google", +"Health Org." ], "type": "string" }, @@ -3833,7 +3835,7 @@ "type": "object" }, "SelectiveGapicGeneration": { -"description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", +"description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases.", "id": "SelectiveGapicGeneration", "properties": { "generateOmittedAsInternal": { @@ -3902,7 +3904,7 @@ "description": "Additional API documentation." }, "endpoints": { -"description": "Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. WARNING: Defining any entries in the `endpoints` list disables the automatic generation of default endpoint variations (e.g., `{service}.clients6.google.com`, `content-{service}.googleapis.com`, and mTLS variants like `{service}.mtls.googleapis.com`). To retain these default variations, you are required to explicitly include your main service endpoint (e.g., `myservice.googleapis.com`) in this list alongside any other custom endpoints (like REP, GFE, etc.).", +"description": "Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.", "items": { "$ref": "Endpoint" }, @@ -4266,7 +4268,7 @@ "id": "UsageRule", "properties": { "allowUnregisteredCalls": { -"description": " Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", +"description": "Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", "type": "boolean" }, "selector": { diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json index 76af2768f4..6640f6acc7 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json @@ -307,7 +307,7 @@ } } }, -"revision": "20260223", +"revision": "20260406", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -657,7 +657,7 @@ "type": "object" }, "pathTranslation": { -"description": "no-lint", +"description": "Path translation specifies how to combine the backend address with the request path in order to produce the appropriate forwarding URL for the request. See PathTranslation for more details.", "enum": [ "PATH_TRANSLATION_UNSPECIFIED", "CONSTANT_ADDRESS", @@ -933,7 +933,7 @@ }, "selectiveGapicGeneration": { "$ref": "SelectiveGapicGeneration", -"description": "Configuration for which RPCs should be generated in the GAPIC client." +"description": "Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases." } }, "type": "object" @@ -2531,7 +2531,8 @@ "STREET_VIEW", "SHOPPING", "GEO", -"GENERATIVE_AI" +"GENERATIVE_AI", +"HEALTH" ], "enumDescriptions": [ "Not useful.", @@ -2541,7 +2542,8 @@ "Street View Org.", "Shopping Org.", "Geo Org.", -"Generative AI - https://developers.generativeai.google" +"Generative AI - https://developers.generativeai.google", +"Health Org." ], "type": "string" }, @@ -2750,7 +2752,7 @@ "type": "object" }, "SelectiveGapicGeneration": { -"description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", +"description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases.", "id": "SelectiveGapicGeneration", "properties": { "generateOmittedAsInternal": { @@ -2819,7 +2821,7 @@ "description": "Additional API documentation." }, "endpoints": { -"description": "Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. WARNING: Defining any entries in the `endpoints` list disables the automatic generation of default endpoint variations (e.g., `{service}.clients6.google.com`, `content-{service}.googleapis.com`, and mTLS variants like `{service}.mtls.googleapis.com`). To retain these default variations, you are required to explicitly include your main service endpoint (e.g., `myservice.googleapis.com`) in this list alongside any other custom endpoints (like REP, GFE, etc.).", +"description": "Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.", "items": { "$ref": "Endpoint" }, @@ -3149,7 +3151,7 @@ "id": "UsageRule", "properties": { "allowUnregisteredCalls": { -"description": " Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", +"description": "Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", "type": "boolean" }, "selector": { diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json index 763823e60a..e44628c55f 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json @@ -431,7 +431,7 @@ } } }, -"revision": "20260317", +"revision": "20260403", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -829,7 +829,7 @@ "type": "object" }, "pathTranslation": { -"description": "no-lint", +"description": "Path translation specifies how to combine the backend address with the request path in order to produce the appropriate forwarding URL for the request. See PathTranslation for more details.", "enum": [ "PATH_TRANSLATION_UNSPECIFIED", "CONSTANT_ADDRESS", @@ -1162,7 +1162,7 @@ }, "selectiveGapicGeneration": { "$ref": "SelectiveGapicGeneration", -"description": "Configuration for which RPCs should be generated in the GAPIC client." +"description": "Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases." } }, "type": "object" @@ -1964,7 +1964,7 @@ "description": "Additional API documentation." }, "endpoints": { -"description": "Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. WARNING: Defining any entries in the `endpoints` list disables the automatic generation of default endpoint variations (e.g., `{service}.clients6.google.com`, `content-{service}.googleapis.com`, and mTLS variants like `{service}.mtls.googleapis.com`). To retain these default variations, you are required to explicitly include your main service endpoint (e.g., `myservice.googleapis.com`) in this list alongside any other custom endpoints (like REP, GFE, etc.).", +"description": "Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.", "items": { "$ref": "Endpoint" }, @@ -3625,7 +3625,7 @@ "type": "object" }, "SelectiveGapicGeneration": { -"description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", +"description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases.", "id": "SelectiveGapicGeneration", "properties": { "generateOmittedAsInternal": { @@ -3866,7 +3866,7 @@ "id": "UsageRule", "properties": { "allowUnregisteredCalls": { -"description": " Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", +"description": "Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", "type": "boolean" }, "selector": { diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json index a1ac13c49a..fa575f09e6 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json @@ -969,7 +969,7 @@ } } }, -"revision": "20260317", +"revision": "20260403", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1367,7 +1367,7 @@ "type": "object" }, "pathTranslation": { -"description": "no-lint", +"description": "Path translation specifies how to combine the backend address with the request path in order to produce the appropriate forwarding URL for the request. See PathTranslation for more details.", "enum": [ "PATH_TRANSLATION_UNSPECIFIED", "CONSTANT_ADDRESS", @@ -1680,7 +1680,7 @@ }, "selectiveGapicGeneration": { "$ref": "SelectiveGapicGeneration", -"description": "Configuration for which RPCs should be generated in the GAPIC client." +"description": "Configuration for which RPCs should be generated in the GAPIC client. Note: This field should not be used in most cases." } }, "type": "object" @@ -2541,7 +2541,7 @@ "description": "Additional API documentation." }, "endpoints": { -"description": "Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. WARNING: Defining any entries in the `endpoints` list disables the automatic generation of default endpoint variations (e.g., `{service}.clients6.google.com`, `content-{service}.googleapis.com`, and mTLS variants like `{service}.mtls.googleapis.com`). To retain these default variations, you are required to explicitly include your main service endpoint (e.g., `myservice.googleapis.com`) in this list alongside any other custom endpoints (like REP, GFE, etc.).", +"description": "Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.", "items": { "$ref": "Endpoint" }, @@ -4424,7 +4424,7 @@ "type": "object" }, "SelectiveGapicGeneration": { -"description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", +"description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries. Note: This feature should not be used in most cases.", "id": "SelectiveGapicGeneration", "properties": { "generateOmittedAsInternal": { @@ -4754,7 +4754,7 @@ "id": "UsageRule", "properties": { "allowUnregisteredCalls": { -"description": " Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", +"description": "Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). WARNING: By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity.", "type": "boolean" }, "selector": { diff --git a/googleapiclient/discovery_cache/documents/slides.v1.json b/googleapiclient/discovery_cache/documents/slides.v1.json index c8f59cd23d..424e82138b 100644 --- a/googleapiclient/discovery_cache/documents/slides.v1.json +++ b/googleapiclient/discovery_cache/documents/slides.v1.json @@ -284,13 +284,15 @@ "THUMBNAIL_SIZE_UNSPECIFIED", "LARGE", "MEDIUM", -"SMALL" +"SMALL", +"WIDTH2000_PX" ], "enumDescriptions": [ "The default thumbnail image size. The unspecified thumbnail size implies that the server chooses the size of the image in a way that might vary in the future.", "The thumbnail image width of 1600px.", "The thumbnail image width of 800px.", -"The thumbnail image width of 200px." +"The thumbnail image width of 200px.", +"The thumbnail image width of 2000px." ], "location": "query", "type": "string" @@ -313,7 +315,7 @@ } } }, -"revision": "20250401", +"revision": "20260408", "rootUrl": "https://slides.googleapis.com/", "schemas": { "AffineTransform": { diff --git a/googleapiclient/discovery_cache/documents/spanner.v1.json b/googleapiclient/discovery_cache/documents/spanner.v1.json index f36a5f5270..365b87e94b 100644 --- a/googleapiclient/discovery_cache/documents/spanner.v1.json +++ b/googleapiclient/discovery_cache/documents/spanner.v1.json @@ -3436,7 +3436,7 @@ } } }, -"revision": "20260319", +"revision": "20260330", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "Ack": { @@ -7121,7 +7121,7 @@ "type": "string" }, "readLockMode": { -"description": "Read lock mode for the transaction.", +"description": "The read lock mode for the transaction.", "enum": [ "READ_LOCK_MODE_UNSPECIFIED", "PESSIMISTIC", diff --git a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json index 0e0b224ae1..b1bd7e66bc 100644 --- a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/workloadmanager.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": "workloadmanager.projects.locations.list", @@ -1248,7 +1248,7 @@ } } }, -"revision": "20260217", +"revision": "20260401", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { "ActiveDirectory": { diff --git a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json index 18a358a35b..9d13d0e738 100644 --- a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json +++ b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json @@ -231,7 +231,7 @@ "subscriptions": { "methods": { "create": { -"description": "Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can create a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", +"description": "Creates a Google Workspace subscription. To learn how to use this method, see [Create a Google Workspace subscription](https://developers.google.com/workspace/events/guides/create-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can create a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", "flatPath": "v1/subscriptions", "httpMethod": "POST", "id": "workspaceevents.subscriptions.create", @@ -416,7 +416,7 @@ ] }, "patch": { -"description": "Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can update a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` andgetting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", +"description": "Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can update a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", "flatPath": "v1/subscriptions/{subscriptionsId}", "httpMethod": "PATCH", "id": "workspaceevents.subscriptions.patch", @@ -474,7 +474,7 @@ ] }, "reactivate": { -"description": "Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can reactivate a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` andgetting one-time administrator approval ([Developer Preview](https://developers.google.com/workspace/preview)). To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", +"description": "Reactivates a suspended Google Workspace subscription. This method resets your subscription's `State` field to `ACTIVE`. Before you use this method, you must fix the error that suspended the subscription. This method will ignore or reject any subscription that isn't currently in a suspended state. To learn how to use this method, see [Reactivate a Google Workspace subscription](https://developers.google.com/workspace/events/guides/reactivate-subscription). For a subscription on a [Chat target resource](https://developers.google.com/workspace/events/guides/events-chat), you can reactivate a subscription as: - A Chat app by specifying an authorization scope that begins with `chat.app` and getting one-time administrator approval. To learn more, see [Authorize as a Chat app with administrator approval](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). - A user by specifying an authorization scope that doesn't include `app` in its name. To learn more, see [Authorize as a Chat user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", "flatPath": "v1/subscriptions/{subscriptionsId}:reactivate", "httpMethod": "POST", "id": "workspaceevents.subscriptions.reactivate", @@ -745,7 +745,7 @@ } } }, -"revision": "20260329", +"revision": "20260407", "rootUrl": "https://workspaceevents.googleapis.com/", "schemas": { "Artifact": { @@ -1211,7 +1211,7 @@ "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).", +"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 created this subscription. Format: `projects/{project_id}/serviceAccounts/{service_account_id}`", "readOnly": true, "type": "string" }, @@ -1249,10 +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 domain administrator has revoked the grant of one or more OAuth scopes for the app.", "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 app that authorized the creation of the subscription no longer has access to the subscription's target resource.", "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.", @@ -1282,7 +1282,7 @@ "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).", +"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}`", "readOnly": true, "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/workstations.v1.json b/googleapiclient/discovery_cache/documents/workstations.v1.json index de1f6f27f0..653429cc2d 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1.json @@ -1221,7 +1221,7 @@ } } }, -"revision": "20260325", +"revision": "20260401", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -2494,6 +2494,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"