From dc4d425ae1e31ef6a9c9736dd32adbc530e54baa Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Wed, 28 Jun 2023 00:26:12 -0700 Subject: [PATCH] feat(all): auto-regenerate discovery clients (#2041) --- api-list.json | 32 +- .../v1/blockchainnodeengine-api.json | 949 +++++ .../v1/blockchainnodeengine-gen.go | 2725 ++++++++++++ cloudfunctions/v2/cloudfunctions-api.json | 6 +- cloudfunctions/v2/cloudfunctions-gen.go | 4 - .../v2alpha/cloudfunctions-api.json | 6 +- cloudfunctions/v2alpha/cloudfunctions-gen.go | 4 - cloudfunctions/v2beta/cloudfunctions-api.json | 6 +- cloudfunctions/v2beta/cloudfunctions-gen.go | 4 - cloudsupport/v2/cloudsupport-api.json | 1386 ++++++ cloudsupport/v2/cloudsupport-gen.go | 3718 +++++++++++++++++ cloudsupport/v2beta/cloudsupport-api.json | 7 +- cloudsupport/v2beta/cloudsupport-gen.go | 12 + .../v1alpha1/contactcenteraiplatform-api.json | 11 +- .../v1alpha1/contactcenteraiplatform-gen.go | 6 +- .../v1/contactcenterinsights-api.json | 38 +- .../v1/contactcenterinsights-gen.go | 22 + container/v1/container-api.json | 35 +- container/v1/container-gen.go | 44 + contentwarehouse/v1/contentwarehouse-api.json | 314 +- contentwarehouse/v1/contentwarehouse-gen.go | 398 +- dataflow/v1b3/dataflow-api.json | 40 +- dataflow/v1b3/dataflow-gen.go | 54 +- dialogflow/v3/dialogflow-api.json | 4 +- dialogflow/v3/dialogflow-gen.go | 5 +- .../v1alpha/discoveryengine-api.json | 78 +- .../v1alpha/discoveryengine-gen.go | 209 +- .../v1beta/discoveryengine-api.json | 78 +- discoveryengine/v1beta/discoveryengine-gen.go | 209 +- displayvideo/v1/displayvideo-api.json | 92 +- displayvideo/v1/displayvideo-gen.go | 62 +- displayvideo/v2/displayvideo-api.json | 92 +- displayvideo/v2/displayvideo-gen.go | 62 +- firestore/v1/firestore-api.json | 55 +- firestore/v1/firestore-gen.go | 63 +- firestore/v1beta1/firestore-api.json | 53 +- firestore/v1beta1/firestore-gen.go | 59 +- firestore/v1beta2/firestore-api.json | 51 +- firestore/v1beta2/firestore-gen.go | 56 + iam/v1/iam-api.json | 192 +- iam/v1/iam-gen.go | 824 +++- sasportal/v1alpha1/sasportal-api.json | 115 +- sasportal/v1alpha1/sasportal-gen.go | 437 ++ searchads360/v0/searchads360-api.json | 290 +- searchads360/v0/searchads360-gen.go | 415 +- .../v1/servicenetworking-api.json | 4 +- servicenetworking/v1/servicenetworking-gen.go | 5 +- .../v1beta/servicenetworking-api.json | 4 +- .../v1beta/servicenetworking-gen.go | 5 +- vault/v1/vault-api.json | 6 +- vault/v1/vault-gen.go | 10 +- 51 files changed, 12824 insertions(+), 532 deletions(-) create mode 100644 blockchainnodeengine/v1/blockchainnodeengine-api.json create mode 100644 blockchainnodeengine/v1/blockchainnodeengine-gen.go create mode 100644 cloudsupport/v2/cloudsupport-api.json create mode 100644 cloudsupport/v2/cloudsupport-gen.go diff --git a/api-list.json b/api-list.json index 9b366640e82..e4fa3b6ea66 100644 --- a/api-list.json +++ b/api-list.json @@ -841,6 +841,21 @@ "documentationLink": "https://cloud.google.com/binary-authorization/", "preferred": true }, + { + "kind": "discovery#directoryItem", + "id": "blockchainnodeengine:v1", + "name": "blockchainnodeengine", + "version": "v1", + "title": "Blockchain Node Engine API", + "description": "", + "discoveryRestUrl": "https://blockchainnodeengine.googleapis.com/$discovery/rest?version=v1", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "documentationLink": "https://cloud.google.com/blockchain-node-engine", + "preferred": true + }, { "kind": "discovery#directoryItem", "id": "blogger:v2", @@ -1484,6 +1499,21 @@ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, "documentationLink": "https://cloud.google.com/support/docs/apis", + "preferred": false + }, + { + "kind": "discovery#directoryItem", + "id": "cloudsupport:v2", + "name": "cloudsupport", + "version": "v2", + "title": "Google Cloud Support API", + "description": "Manages Google Cloud technical support cases for Customer Care support offerings.", + "discoveryRestUrl": "https://cloudsupport.googleapis.com/$discovery/rest?version=v2", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "documentationLink": "https://cloud.google.com/support/docs/apis", "preferred": true }, { @@ -6088,7 +6118,7 @@ "name": "workloadmanager", "version": "v1", "title": "Workload Manager API", - "description": "", + "description": "Workload Manager is a service that provides tooling for enterprise workloads to automate the deployment and validation of your workloads against best practices and recommendations.", "discoveryRestUrl": "https://workloadmanager.googleapis.com/$discovery/rest?version=v1", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", diff --git a/blockchainnodeengine/v1/blockchainnodeengine-api.json b/blockchainnodeengine/v1/blockchainnodeengine-api.json new file mode 100644 index 00000000000..a7166892eb2 --- /dev/null +++ b/blockchainnodeengine/v1/blockchainnodeengine-api.json @@ -0,0 +1,949 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." + } + } + } + }, + "basePath": "", + "baseUrl": "https://blockchainnodeengine.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Blockchain Node Engine", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/blockchain-node-engine", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "blockchainnodeengine:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://blockchainnodeengine.mtls.googleapis.com/", + "name": "blockchainnodeengine", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", + "httpMethod": "GET", + "id": "blockchainnodeengine.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "flatPath": "v1/projects/{projectsId}/locations", + "httpMethod": "GET", + "id": "blockchainnodeengine.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "blockchainNodes": { + "methods": { + "create": { + "description": "Creates a new blockchain node in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes", + "httpMethod": "POST", + "id": "blockchainnodeengine.projects.locations.blockchainNodes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "blockchainNodeId": { + "description": "Required. ID of the requesting object.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Value for parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/blockchainNodes", + "request": { + "$ref": "BlockchainNode" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single blockchain node.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes/{blockchainNodesId}", + "httpMethod": "DELETE", + "id": "blockchainnodeengine.projects.locations.blockchainNodes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the blockchain node to delete. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/blockchainNodes/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single blockchain node.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes/{blockchainNodesId}", + "httpMethod": "GET", + "id": "blockchainnodeengine.projects.locations.blockchainNodes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the blockchain node to fetch. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/blockchainNodes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "BlockchainNode" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists blockchain nodes in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes", + "httpMethod": "GET", + "id": "blockchainnodeengine.projects.locations.blockchainNodes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent value for `ListNodesRequest`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/blockchainNodes", + "response": { + "$ref": "ListBlockchainNodesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single blockchain node.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes/{blockchainNodesId}", + "httpMethod": "PATCH", + "id": "blockchainnodeengine.projects.locations.blockchainNodes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The fully qualified name of the blockchain node. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/blockchainNodes/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the Blockchain node resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "BlockchainNode" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "blockchainnodeengine.projects.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "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}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "blockchainnodeengine.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "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}/operations/{operationsId}", + "httpMethod": "GET", + "id": "blockchainnodeengine.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", + "httpMethod": "GET", + "id": "blockchainnodeengine.projects.locations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20230621", + "rootUrl": "https://blockchainnodeengine.googleapis.com/", + "schemas": { + "BlockchainNode": { + "description": "A representation of a blockchain node.", + "id": "BlockchainNode", + "properties": { + "blockchainType": { + "description": "Immutable. The blockchain type of the node.", + "enum": [ + "BLOCKCHAIN_TYPE_UNSPECIFIED", + "ETHEREUM" + ], + "enumDescriptions": [ + "Blockchain type has not been specified, but should be.", + "The blockchain type is Ethereum." + ], + "type": "string" + }, + "connectionInfo": { + "$ref": "ConnectionInfo", + "description": "Output only. The connection information used to interact with a blockchain node.", + "readOnly": true + }, + "createTime": { + "description": "Output only. The timestamp at which the blockchain node was first created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "ethereumDetails": { + "$ref": "EthereumDetails", + "description": "Ethereum-specific blockchain node details." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "User-provided key-value pairs.", + "type": "object" + }, + "name": { + "description": "Output only. The fully qualified name of the blockchain node. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. A status representing the state of the node.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "DELETING", + "RUNNING", + "ERROR", + "UPDATING", + "REPAIRING", + "RECONCILING" + ], + "enumDescriptions": [ + "The state has not been specified.", + "The node has been requested and is in the process of being created.", + "The existing node is undergoing deletion, but is not yet finished.", + "The node is running and ready for use.", + "The node is in an unexpected or errored state.", + "The node is currently being updated.", + "The node is currently being repaired.", + "The node is currently being reconciled." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp at which the blockchain node was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "ConnectionInfo": { + "description": "The connection information through which to interact with a blockchain node.", + "id": "ConnectionInfo", + "properties": { + "endpointInfo": { + "$ref": "EndpointInfo", + "description": "Output only. The endpoint information through which to interact with a blockchain node.", + "readOnly": true + } + }, + "type": "object" + }, + "EndpointInfo": { + "description": "Contains endpoint information through which to interact with a blockchain node.", + "id": "EndpointInfo", + "properties": { + "jsonRpcApiEndpoint": { + "description": "Output only. The assigned URL for the node JSON-RPC API endpoint.", + "readOnly": true, + "type": "string" + }, + "websocketsApiEndpoint": { + "description": "Output only. The assigned URL for the node WebSockets API endpoint.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "EthereumDetails": { + "description": "Ethereum-specific blockchain node details.", + "id": "EthereumDetails", + "properties": { + "additionalEndpoints": { + "$ref": "EthereumEndpoints", + "description": "Output only. Ethereum-specific endpoint information.", + "readOnly": true + }, + "apiEnableAdmin": { + "description": "Immutable. Enables JSON-RPC access to functions in the `admin` namespace. Defaults to `false`.", + "type": "boolean" + }, + "apiEnableDebug": { + "description": "Immutable. Enables JSON-RPC access to functions in the `debug` namespace. Defaults to `false`.", + "type": "boolean" + }, + "consensusClient": { + "description": "Immutable. The consensus client.", + "enum": [ + "CONSENSUS_CLIENT_UNSPECIFIED", + "LIGHTHOUSE", + "ERIGON_EMBEDDED_CONSENSUS_LAYER" + ], + "enumDeprecated": [ + false, + false, + true + ], + "enumDescriptions": [ + "Consensus client has not been specified, but should be.", + "Consensus client implementation written in Rust, maintained by Sigma Prime. See [Lighthouse - Sigma Prime](https://lighthouse.sigmaprime.io/) for details.", + "Erigon's embedded consensus client embedded in the execution client. Note this option is not currently available when creating new blockchain nodes. See [Erigon on GitHub](https://github.com/ledgerwatch/erigon#embedded-consensus-layer) for details." + ], + "type": "string" + }, + "executionClient": { + "description": "Immutable. The execution client", + "enum": [ + "EXECUTION_CLIENT_UNSPECIFIED", + "GETH", + "ERIGON" + ], + "enumDescriptions": [ + "Execution client has not been specified, but should be.", + "Official Go implementation of the Ethereum protocol. See [go-ethereum](https://geth.ethereum.org/) for details.", + "An implementation of Ethereum (execution client), on the efficiency frontier, written in Go. See [Erigon on GitHub](https://github.com/ledgerwatch/erigon) for details." + ], + "type": "string" + }, + "gethDetails": { + "$ref": "GethDetails", + "description": "Details for the Geth execution client." + }, + "network": { + "description": "Immutable. The Ethereum environment being accessed.", + "enum": [ + "NETWORK_UNSPECIFIED", + "MAINNET", + "TESTNET_GOERLI_PRATER", + "TESTNET_SEPOLIA" + ], + "enumDescriptions": [ + "The network has not been specified, but should be.", + "The Ethereum Mainnet.", + "The Ethereum Testnet based on Goerli protocol.", + "The Ethereum Testnet based on Sepolia/Bepolia protocol." + ], + "type": "string" + }, + "nodeType": { + "description": "Immutable. The type of Ethereum node.", + "enum": [ + "NODE_TYPE_UNSPECIFIED", + "LIGHT", + "FULL", + "ARCHIVE" + ], + "enumDescriptions": [ + "Node type has not been specified, but should be.", + "An Ethereum node that only downloads Ethereum block headers.", + "Keeps a complete copy of the blockchain data, and contributes to the network by receiving, validating, and forwarding transactions.", + "Holds the same data as full node as well as all of the blockchain's history state data dating back to the Genesis Block." + ], + "type": "string" + } + }, + "type": "object" + }, + "EthereumEndpoints": { + "description": "Contains endpoint information specific to Ethereum nodes.", + "id": "EthereumEndpoints", + "properties": { + "beaconApiEndpoint": { + "description": "Output only. The assigned URL for the node's Beacon API endpoint.", + "readOnly": true, + "type": "string" + }, + "beaconPrometheusMetricsApiEndpoint": { + "description": "Output only. The assigned URL for the node's Beacon Prometheus metrics endpoint. See [Prometheus Metrics](https://lighthouse-book.sigmaprime.io/advanced_metrics.html) for more details.", + "readOnly": true, + "type": "string" + }, + "executionClientPrometheusMetricsApiEndpoint": { + "description": "Output only. The assigned URL for the node's execution client's Prometheus metrics endpoint.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GethDetails": { + "description": "Options for the Geth execution client. See [Command-line Options](https://geth.ethereum.org/docs/fundamentals/command-line-options) for more details.", + "id": "GethDetails", + "properties": { + "garbageCollectionMode": { + "description": "Immutable. Blockchain garbage collection mode.", + "enum": [ + "GARBAGE_COLLECTION_MODE_UNSPECIFIED", + "FULL", + "ARCHIVE" + ], + "enumDescriptions": [ + "The garbage collection has not been specified.", + "Configures Geth's garbage collection so that older data not needed for a full node is deleted. This is the default mode when creating a full node.", + "Configures Geth's garbage collection so that old data is never deleted. This is the default mode when creating an archive node. This value can also be chosen when creating a full node in order to create a partial/recent archive node. See [Sync modes](https://geth.ethereum.org/docs/fundamentals/sync-modes) for more details." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleProtobufEmpty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "GoogleProtobufEmpty", + "properties": {}, + "type": "object" + }, + "ListBlockchainNodesResponse": { + "description": "Message for response to listing blockchain nodes.", + "id": "ListBlockchainNodesResponse", + "properties": { + "blockchainNodes": { + "description": "The list of nodes", + "items": { + "$ref": "BlockchainNode" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents a Google Cloud location.", + "id": "Location", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "OperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have `Operation.error` value with a `google.rpc.Status.code` of `1`, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, + "type": "string" + }, + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Blockchain Node Engine API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/blockchainnodeengine/v1/blockchainnodeengine-gen.go b/blockchainnodeengine/v1/blockchainnodeengine-gen.go new file mode 100644 index 00000000000..9839b93b442 --- /dev/null +++ b/blockchainnodeengine/v1/blockchainnodeengine-gen.go @@ -0,0 +1,2725 @@ +// Copyright 2023 Google LLC. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +// Code generated file. DO NOT EDIT. + +// Package blockchainnodeengine provides access to the Blockchain Node Engine API. +// +// For product documentation, see: https://cloud.google.com/blockchain-node-engine +// +// # Creating a client +// +// Usage example: +// +// import "google.golang.org/api/blockchainnodeengine/v1" +// ... +// ctx := context.Background() +// blockchainnodeengineService, err := blockchainnodeengine.NewService(ctx) +// +// In this example, Google Application Default Credentials are used for authentication. +// +// For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials. +// +// # Other authentication options +// +// To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey: +// +// blockchainnodeengineService, err := blockchainnodeengine.NewService(ctx, option.WithAPIKey("AIza...")) +// +// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource: +// +// config := &oauth2.Config{...} +// // ... +// token, err := config.Exchange(ctx, ...) +// blockchainnodeengineService, err := blockchainnodeengine.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token))) +// +// See https://godoc.org/google.golang.org/api/option/ for details on options. +package blockchainnodeengine // import "google.golang.org/api/blockchainnodeengine/v1" + +import ( + "bytes" + "context" + "encoding/json" + "errors" + "fmt" + "io" + "net/http" + "net/url" + "strconv" + "strings" + + googleapi "google.golang.org/api/googleapi" + internal "google.golang.org/api/internal" + gensupport "google.golang.org/api/internal/gensupport" + option "google.golang.org/api/option" + internaloption "google.golang.org/api/option/internaloption" + htransport "google.golang.org/api/transport/http" +) + +// Always reference these packages, just in case the auto-generated code +// below doesn't. +var _ = bytes.NewBuffer +var _ = strconv.Itoa +var _ = fmt.Sprintf +var _ = json.NewDecoder +var _ = io.Copy +var _ = url.Parse +var _ = gensupport.MarshalJSON +var _ = googleapi.Version +var _ = errors.New +var _ = strings.Replace +var _ = context.Canceled +var _ = internaloption.WithDefaultEndpoint +var _ = internal.Version + +const apiId = "blockchainnodeengine:v1" +const apiName = "blockchainnodeengine" +const apiVersion = "v1" +const basePath = "https://blockchainnodeengine.googleapis.com/" +const mtlsBasePath = "https://blockchainnodeengine.mtls.googleapis.com/" + +// OAuth2 scopes used by this API. +const ( + // See, edit, configure, and delete your Google Cloud data and see the + // email address for your Google Account. + CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform" +) + +// NewService creates a new Service. +func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) { + scopesOption := internaloption.WithDefaultScopes( + "https://www.googleapis.com/auth/cloud-platform", + ) + // NOTE: prepend, so we don't override user-specified scopes. + opts = append([]option.ClientOption{scopesOption}, opts...) + opts = append(opts, internaloption.WithDefaultEndpoint(basePath)) + opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath)) + client, endpoint, err := htransport.NewClient(ctx, opts...) + if err != nil { + return nil, err + } + s, err := New(client) + if err != nil { + return nil, err + } + if endpoint != "" { + s.BasePath = endpoint + } + return s, nil +} + +// New creates a new Service. It uses the provided http.Client for requests. +// +// Deprecated: please use NewService instead. +// To provide a custom HTTP client, use option.WithHTTPClient. +// If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead. +func New(client *http.Client) (*Service, error) { + if client == nil { + return nil, errors.New("client is nil") + } + s := &Service{client: client, BasePath: basePath} + s.Projects = NewProjectsService(s) + return s, nil +} + +type Service struct { + client *http.Client + BasePath string // API endpoint base URL + UserAgent string // optional additional User-Agent fragment + + Projects *ProjectsService +} + +func (s *Service) userAgent() string { + if s.UserAgent == "" { + return googleapi.UserAgent + } + return googleapi.UserAgent + " " + s.UserAgent +} + +func NewProjectsService(s *Service) *ProjectsService { + rs := &ProjectsService{s: s} + rs.Locations = NewProjectsLocationsService(s) + return rs +} + +type ProjectsService struct { + s *Service + + Locations *ProjectsLocationsService +} + +func NewProjectsLocationsService(s *Service) *ProjectsLocationsService { + rs := &ProjectsLocationsService{s: s} + rs.BlockchainNodes = NewProjectsLocationsBlockchainNodesService(s) + rs.Operations = NewProjectsLocationsOperationsService(s) + return rs +} + +type ProjectsLocationsService struct { + s *Service + + BlockchainNodes *ProjectsLocationsBlockchainNodesService + + Operations *ProjectsLocationsOperationsService +} + +func NewProjectsLocationsBlockchainNodesService(s *Service) *ProjectsLocationsBlockchainNodesService { + rs := &ProjectsLocationsBlockchainNodesService{s: s} + return rs +} + +type ProjectsLocationsBlockchainNodesService struct { + s *Service +} + +func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService { + rs := &ProjectsLocationsOperationsService{s: s} + return rs +} + +type ProjectsLocationsOperationsService struct { + s *Service +} + +// BlockchainNode: A representation of a blockchain node. +type BlockchainNode struct { + // BlockchainType: Immutable. The blockchain type of the node. + // + // Possible values: + // "BLOCKCHAIN_TYPE_UNSPECIFIED" - Blockchain type has not been + // specified, but should be. + // "ETHEREUM" - The blockchain type is Ethereum. + BlockchainType string `json:"blockchainType,omitempty"` + + // ConnectionInfo: Output only. The connection information used to + // interact with a blockchain node. + ConnectionInfo *ConnectionInfo `json:"connectionInfo,omitempty"` + + // CreateTime: Output only. The timestamp at which the blockchain node + // was first created. + CreateTime string `json:"createTime,omitempty"` + + // EthereumDetails: Ethereum-specific blockchain node details. + EthereumDetails *EthereumDetails `json:"ethereumDetails,omitempty"` + + // Labels: User-provided key-value pairs. + Labels map[string]string `json:"labels,omitempty"` + + // Name: Output only. The fully qualified name of the blockchain node. + // e.g. + // `projects/my-project/locations/us-central1/blockchainNodes/my-node`. + Name string `json:"name,omitempty"` + + // State: Output only. A status representing the state of the node. + // + // Possible values: + // "STATE_UNSPECIFIED" - The state has not been specified. + // "CREATING" - The node has been requested and is in the process of + // being created. + // "DELETING" - The existing node is undergoing deletion, but is not + // yet finished. + // "RUNNING" - The node is running and ready for use. + // "ERROR" - The node is in an unexpected or errored state. + // "UPDATING" - The node is currently being updated. + // "REPAIRING" - The node is currently being repaired. + // "RECONCILING" - The node is currently being reconciled. + State string `json:"state,omitempty"` + + // UpdateTime: Output only. The timestamp at which the blockchain node + // was last updated. + UpdateTime string `json:"updateTime,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "BlockchainType") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BlockchainType") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *BlockchainNode) MarshalJSON() ([]byte, error) { + type NoMethod BlockchainNode + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CancelOperationRequest: The request message for +// Operations.CancelOperation. +type CancelOperationRequest struct { +} + +// ConnectionInfo: The connection information through which to interact +// with a blockchain node. +type ConnectionInfo struct { + // EndpointInfo: Output only. The endpoint information through which to + // interact with a blockchain node. + EndpointInfo *EndpointInfo `json:"endpointInfo,omitempty"` + + // ForceSendFields is a list of field names (e.g. "EndpointInfo") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "EndpointInfo") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ConnectionInfo) MarshalJSON() ([]byte, error) { + type NoMethod ConnectionInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// EndpointInfo: Contains endpoint information through which to interact +// with a blockchain node. +type EndpointInfo struct { + // JsonRpcApiEndpoint: Output only. The assigned URL for the node + // JSON-RPC API endpoint. + JsonRpcApiEndpoint string `json:"jsonRpcApiEndpoint,omitempty"` + + // WebsocketsApiEndpoint: Output only. The assigned URL for the node + // WebSockets API endpoint. + WebsocketsApiEndpoint string `json:"websocketsApiEndpoint,omitempty"` + + // ForceSendFields is a list of field names (e.g. "JsonRpcApiEndpoint") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "JsonRpcApiEndpoint") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *EndpointInfo) MarshalJSON() ([]byte, error) { + type NoMethod EndpointInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// EthereumDetails: Ethereum-specific blockchain node details. +type EthereumDetails struct { + // AdditionalEndpoints: Output only. Ethereum-specific endpoint + // information. + AdditionalEndpoints *EthereumEndpoints `json:"additionalEndpoints,omitempty"` + + // ApiEnableAdmin: Immutable. Enables JSON-RPC access to functions in + // the `admin` namespace. Defaults to `false`. + ApiEnableAdmin bool `json:"apiEnableAdmin,omitempty"` + + // ApiEnableDebug: Immutable. Enables JSON-RPC access to functions in + // the `debug` namespace. Defaults to `false`. + ApiEnableDebug bool `json:"apiEnableDebug,omitempty"` + + // ConsensusClient: Immutable. The consensus client. + // + // Possible values: + // "CONSENSUS_CLIENT_UNSPECIFIED" - Consensus client has not been + // specified, but should be. + // "LIGHTHOUSE" - Consensus client implementation written in Rust, + // maintained by Sigma Prime. See [Lighthouse - Sigma + // Prime](https://lighthouse.sigmaprime.io/) for details. + // "ERIGON_EMBEDDED_CONSENSUS_LAYER" - Erigon's embedded consensus + // client embedded in the execution client. Note this option is not + // currently available when creating new blockchain nodes. See [Erigon + // on + // GitHub](https://github.com/ledgerwatch/erigon#embedded-consensus-layer + // ) for details. + ConsensusClient string `json:"consensusClient,omitempty"` + + // ExecutionClient: Immutable. The execution client + // + // Possible values: + // "EXECUTION_CLIENT_UNSPECIFIED" - Execution client has not been + // specified, but should be. + // "GETH" - Official Go implementation of the Ethereum protocol. See + // [go-ethereum](https://geth.ethereum.org/) for details. + // "ERIGON" - An implementation of Ethereum (execution client), on the + // efficiency frontier, written in Go. See [Erigon on + // GitHub](https://github.com/ledgerwatch/erigon) for details. + ExecutionClient string `json:"executionClient,omitempty"` + + // GethDetails: Details for the Geth execution client. + GethDetails *GethDetails `json:"gethDetails,omitempty"` + + // Network: Immutable. The Ethereum environment being accessed. + // + // Possible values: + // "NETWORK_UNSPECIFIED" - The network has not been specified, but + // should be. + // "MAINNET" - The Ethereum Mainnet. + // "TESTNET_GOERLI_PRATER" - The Ethereum Testnet based on Goerli + // protocol. + // "TESTNET_SEPOLIA" - The Ethereum Testnet based on Sepolia/Bepolia + // protocol. + Network string `json:"network,omitempty"` + + // NodeType: Immutable. The type of Ethereum node. + // + // Possible values: + // "NODE_TYPE_UNSPECIFIED" - Node type has not been specified, but + // should be. + // "LIGHT" - An Ethereum node that only downloads Ethereum block + // headers. + // "FULL" - Keeps a complete copy of the blockchain data, and + // contributes to the network by receiving, validating, and forwarding + // transactions. + // "ARCHIVE" - Holds the same data as full node as well as all of the + // blockchain's history state data dating back to the Genesis Block. + NodeType string `json:"nodeType,omitempty"` + + // ForceSendFields is a list of field names (e.g. "AdditionalEndpoints") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "AdditionalEndpoints") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *EthereumDetails) MarshalJSON() ([]byte, error) { + type NoMethod EthereumDetails + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// EthereumEndpoints: Contains endpoint information specific to Ethereum +// nodes. +type EthereumEndpoints struct { + // BeaconApiEndpoint: Output only. The assigned URL for the node's + // Beacon API endpoint. + BeaconApiEndpoint string `json:"beaconApiEndpoint,omitempty"` + + // BeaconPrometheusMetricsApiEndpoint: Output only. The assigned URL for + // the node's Beacon Prometheus metrics endpoint. See Prometheus Metrics + // (https://lighthouse-book.sigmaprime.io/advanced_metrics.html) for + // more details. + BeaconPrometheusMetricsApiEndpoint string `json:"beaconPrometheusMetricsApiEndpoint,omitempty"` + + // ExecutionClientPrometheusMetricsApiEndpoint: Output only. The + // assigned URL for the node's execution client's Prometheus metrics + // endpoint. + ExecutionClientPrometheusMetricsApiEndpoint string `json:"executionClientPrometheusMetricsApiEndpoint,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BeaconApiEndpoint") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BeaconApiEndpoint") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *EthereumEndpoints) MarshalJSON() ([]byte, error) { + type NoMethod EthereumEndpoints + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GethDetails: Options for the Geth execution client. See Command-line +// Options +// (https://geth.ethereum.org/docs/fundamentals/command-line-options) +// for more details. +type GethDetails struct { + // GarbageCollectionMode: Immutable. Blockchain garbage collection mode. + // + // Possible values: + // "GARBAGE_COLLECTION_MODE_UNSPECIFIED" - The garbage collection has + // not been specified. + // "FULL" - Configures Geth's garbage collection so that older data + // not needed for a full node is deleted. This is the default mode when + // creating a full node. + // "ARCHIVE" - Configures Geth's garbage collection so that old data + // is never deleted. This is the default mode when creating an archive + // node. This value can also be chosen when creating a full node in + // order to create a partial/recent archive node. See [Sync + // modes](https://geth.ethereum.org/docs/fundamentals/sync-modes) for + // more details. + GarbageCollectionMode string `json:"garbageCollectionMode,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "GarbageCollectionMode") to unconditionally include in API requests. + // By default, fields with empty or default values are omitted from API + // requests. However, any non-pointer, non-interface field appearing in + // ForceSendFields will be sent to the server regardless of whether the + // field is empty or not. This may be used to include empty fields in + // Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "GarbageCollectionMode") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GethDetails) MarshalJSON() ([]byte, error) { + type NoMethod GethDetails + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleProtobufEmpty: 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); } +type GoogleProtobufEmpty struct { + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` +} + +// ListBlockchainNodesResponse: Message for response to listing +// blockchain nodes. +type ListBlockchainNodesResponse struct { + // BlockchainNodes: The list of nodes + BlockchainNodes []*BlockchainNode `json:"blockchainNodes,omitempty"` + + // NextPageToken: A token identifying a page of results the server + // should return. + NextPageToken string `json:"nextPageToken,omitempty"` + + // Unreachable: Locations that could not be reached. + Unreachable []string `json:"unreachable,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "BlockchainNodes") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BlockchainNodes") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *ListBlockchainNodesResponse) MarshalJSON() ([]byte, error) { + type NoMethod ListBlockchainNodesResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// ListLocationsResponse: The response message for +// Locations.ListLocations. +type ListLocationsResponse struct { + // Locations: A list of locations that matches the specified filter in + // the request. + Locations []*Location `json:"locations,omitempty"` + + // NextPageToken: The standard List next-page token. + NextPageToken string `json:"nextPageToken,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "Locations") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Locations") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ListLocationsResponse) MarshalJSON() ([]byte, error) { + type NoMethod ListLocationsResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// ListOperationsResponse: The response message for +// Operations.ListOperations. +type ListOperationsResponse struct { + // NextPageToken: The standard List next-page token. + NextPageToken string `json:"nextPageToken,omitempty"` + + // Operations: A list of operations that matches the specified filter in + // the request. + Operations []*Operation `json:"operations,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "NextPageToken") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "NextPageToken") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ListOperationsResponse) MarshalJSON() ([]byte, error) { + type NoMethod ListOperationsResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// Location: A resource that represents a Google Cloud location. +type Location struct { + // DisplayName: The friendly name for this location, typically a nearby + // city name. For example, "Tokyo". + DisplayName string `json:"displayName,omitempty"` + + // Labels: Cross-service attributes for the location. For example + // {"cloud.googleapis.com/region": "us-east1"} + Labels map[string]string `json:"labels,omitempty"` + + // LocationId: The canonical id for this location. For example: + // "us-east1". + LocationId string `json:"locationId,omitempty"` + + // Metadata: Service-specific metadata. For example the available + // capacity at the given location. + Metadata googleapi.RawMessage `json:"metadata,omitempty"` + + // Name: Resource name for the location, which may vary between + // implementations. For example: + // "projects/example-project/locations/us-east1" + Name string `json:"name,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "DisplayName") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DisplayName") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *Location) MarshalJSON() ([]byte, error) { + type NoMethod Location + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// Operation: This resource represents a long-running operation that is +// the result of a network API call. +type Operation struct { + // Done: 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. + Done bool `json:"done,omitempty"` + + // Error: The error result of the operation in case of failure or + // cancellation. + Error *Status `json:"error,omitempty"` + + // 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. + Metadata googleapi.RawMessage `json:"metadata,omitempty"` + + // Name: 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}`. + Name string `json:"name,omitempty"` + + // Response: The normal response of the operation in case of success. If + // the original method returns no data on success, such as `Delete`, the + // response is `google.protobuf.Empty`. If the original method is + // standard `Get`/`Create`/`Update`, the response should be the + // resource. For other methods, the response should have the type + // `XxxResponse`, where `Xxx` is the original method name. For example, + // if the original method name is `TakeSnapshot()`, the inferred + // response type is `TakeSnapshotResponse`. + Response googleapi.RawMessage `json:"response,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "Done") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Done") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *Operation) MarshalJSON() ([]byte, error) { + type NoMethod Operation + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// OperationMetadata: Represents the metadata of the long-running +// operation. +type OperationMetadata struct { + // ApiVersion: Output only. API version used to start the operation. + ApiVersion string `json:"apiVersion,omitempty"` + + // CreateTime: Output only. The time the operation was created. + CreateTime string `json:"createTime,omitempty"` + + // EndTime: Output only. The time the operation finished running. + EndTime string `json:"endTime,omitempty"` + + // RequestedCancellation: Output only. Identifies whether the user has + // requested cancellation of the operation. Operations that have been + // cancelled successfully have `Operation.error` value with a + // `google.rpc.Status.code` of `1`, corresponding to `Code.CANCELLED`. + RequestedCancellation bool `json:"requestedCancellation,omitempty"` + + // StatusMessage: Output only. Human-readable status of the operation, + // if any. + StatusMessage string `json:"statusMessage,omitempty"` + + // Target: Output only. Server-defined resource path for the target of + // the operation. + Target string `json:"target,omitempty"` + + // Verb: Output only. Name of the verb executed by the operation. + Verb string `json:"verb,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ApiVersion") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ApiVersion") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *OperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod OperationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// Status: 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). +type Status struct { + // Code: The status code, which should be an enum value of + // google.rpc.Code. + Code int64 `json:"code,omitempty"` + + // Details: A list of messages that carry the error details. There is a + // common set of message types for APIs to use. + Details []googleapi.RawMessage `json:"details,omitempty"` + + // Message: 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. + Message string `json:"message,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Code") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Code") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *Status) MarshalJSON() ([]byte, error) { + type NoMethod Status + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// method id "blockchainnodeengine.projects.locations.get": + +type ProjectsLocationsGetCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// Get: Gets information about a location. +// +// - name: Resource name for the location. +func (r *ProjectsLocationsService) Get(name string) *ProjectsLocationsGetCall { + c := &ProjectsLocationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsGetCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsGetCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "blockchainnodeengine.projects.locations.get" call. +// Exactly one of *Location or error will be non-nil. Any non-2xx status +// code is an error. Response headers are in either +// *Location.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified +// to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Location{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Gets information about a location.", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", + // "httpMethod": "GET", + // "id": "blockchainnodeengine.projects.locations.get", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "Resource name for the location.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1/{+name}", + // "response": { + // "$ref": "Location" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "blockchainnodeengine.projects.locations.list": + +type ProjectsLocationsListCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// List: Lists information about the supported locations for this +// service. +// +// - name: The resource that owns the locations collection, if +// applicable. +func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall { + c := &ProjectsLocationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Filter sets the optional parameter "filter": A filter to narrow down +// results to a preferred subset. The filtering language accepts strings +// like "displayName=tokyo", and is documented in more detail in +// AIP-160 (https://google.aip.dev/160). +func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall { + c.urlParams_.Set("filter", filter) + return c +} + +// PageSize sets the optional parameter "pageSize": The maximum number +// of results to return. If not set, the service selects a default. +func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall { + c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) + return c +} + +// PageToken sets the optional parameter "pageToken": A page token +// received from the `next_page_token` field in the response. Send that +// page token to receive the subsequent page. +func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall { + c.urlParams_.Set("pageToken", pageToken) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsListCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsListCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}/locations") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "blockchainnodeengine.projects.locations.list" call. +// Exactly one of *ListLocationsResponse or error will be non-nil. Any +// non-2xx status code is an error. Response headers are in either +// *ListLocationsResponse.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &ListLocationsResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Lists information about the supported locations for this service.", + // "flatPath": "v1/projects/{projectsId}/locations", + // "httpMethod": "GET", + // "id": "blockchainnodeengine.projects.locations.list", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "filter": { + // "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", + // "location": "query", + // "type": "string" + // }, + // "name": { + // "description": "The resource that owns the locations collection, if applicable.", + // "location": "path", + // "pattern": "^projects/[^/]+$", + // "required": true, + // "type": "string" + // }, + // "pageSize": { + // "description": "The maximum number of results to return. If not set, the service selects a default.", + // "format": "int32", + // "location": "query", + // "type": "integer" + // }, + // "pageToken": { + // "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", + // "location": "query", + // "type": "string" + // } + // }, + // "path": "v1/{+name}/locations", + // "response": { + // "$ref": "ListLocationsResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// Pages invokes f for each page of results. +// A non-nil error returned from f will halt the iteration. +// The provided context supersedes any context provided to the Context method. +func (c *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*ListLocationsResponse) error) error { + c.ctx_ = ctx + defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point + for { + x, err := c.Do() + if err != nil { + return err + } + if err := f(x); err != nil { + return err + } + if x.NextPageToken == "" { + return nil + } + c.PageToken(x.NextPageToken) + } +} + +// method id "blockchainnodeengine.projects.locations.blockchainNodes.create": + +type ProjectsLocationsBlockchainNodesCreateCall struct { + s *Service + parent string + blockchainnode *BlockchainNode + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Create: Creates a new blockchain node in a given project and +// location. +// +// - parent: Value for parent. +func (r *ProjectsLocationsBlockchainNodesService) Create(parent string, blockchainnode *BlockchainNode) *ProjectsLocationsBlockchainNodesCreateCall { + c := &ProjectsLocationsBlockchainNodesCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + c.blockchainnode = blockchainnode + return c +} + +// BlockchainNodeId sets the optional parameter "blockchainNodeId": +// Required. ID of the requesting object. +func (c *ProjectsLocationsBlockchainNodesCreateCall) BlockchainNodeId(blockchainNodeId string) *ProjectsLocationsBlockchainNodesCreateCall { + c.urlParams_.Set("blockchainNodeId", blockchainNodeId) + return c +} + +// RequestId sets the optional parameter "requestId": 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). +func (c *ProjectsLocationsBlockchainNodesCreateCall) RequestId(requestId string) *ProjectsLocationsBlockchainNodesCreateCall { + c.urlParams_.Set("requestId", requestId) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsBlockchainNodesCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsBlockchainNodesCreateCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsBlockchainNodesCreateCall) Context(ctx context.Context) *ProjectsLocationsBlockchainNodesCreateCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsBlockchainNodesCreateCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsBlockchainNodesCreateCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.blockchainnode) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/blockchainNodes") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "blockchainnodeengine.projects.locations.blockchainNodes.create" call. +// Exactly one of *Operation or error will be non-nil. Any non-2xx +// status code is an error. Response headers are in either +// *Operation.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified +// to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsBlockchainNodesCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Operation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Creates a new blockchain node in a given project and location.", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes", + // "httpMethod": "POST", + // "id": "blockchainnodeengine.projects.locations.blockchainNodes.create", + // "parameterOrder": [ + // "parent" + // ], + // "parameters": { + // "blockchainNodeId": { + // "description": "Required. ID of the requesting object.", + // "location": "query", + // "type": "string" + // }, + // "parent": { + // "description": "Required. Value for parent.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+$", + // "required": true, + // "type": "string" + // }, + // "requestId": { + // "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + // "location": "query", + // "type": "string" + // } + // }, + // "path": "v1/{+parent}/blockchainNodes", + // "request": { + // "$ref": "BlockchainNode" + // }, + // "response": { + // "$ref": "Operation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "blockchainnodeengine.projects.locations.blockchainNodes.delete": + +type ProjectsLocationsBlockchainNodesDeleteCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Delete: Deletes a single blockchain node. +// +// - name: The fully qualified name of the blockchain node to delete. +// e.g. +// `projects/my-project/locations/us-central1/blockchainNodes/my-node`. +func (r *ProjectsLocationsBlockchainNodesService) Delete(name string) *ProjectsLocationsBlockchainNodesDeleteCall { + c := &ProjectsLocationsBlockchainNodesDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// RequestId sets the optional parameter "requestId": 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). +func (c *ProjectsLocationsBlockchainNodesDeleteCall) RequestId(requestId string) *ProjectsLocationsBlockchainNodesDeleteCall { + c.urlParams_.Set("requestId", requestId) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsBlockchainNodesDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsBlockchainNodesDeleteCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsBlockchainNodesDeleteCall) Context(ctx context.Context) *ProjectsLocationsBlockchainNodesDeleteCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsBlockchainNodesDeleteCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsBlockchainNodesDeleteCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("DELETE", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "blockchainnodeengine.projects.locations.blockchainNodes.delete" call. +// Exactly one of *Operation or error will be non-nil. Any non-2xx +// status code is an error. Response headers are in either +// *Operation.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified +// to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsBlockchainNodesDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Operation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Deletes a single blockchain node.", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes/{blockchainNodesId}", + // "httpMethod": "DELETE", + // "id": "blockchainnodeengine.projects.locations.blockchainNodes.delete", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "Required. The fully qualified name of the blockchain node to delete. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/blockchainNodes/[^/]+$", + // "required": true, + // "type": "string" + // }, + // "requestId": { + // "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + // "location": "query", + // "type": "string" + // } + // }, + // "path": "v1/{+name}", + // "response": { + // "$ref": "Operation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "blockchainnodeengine.projects.locations.blockchainNodes.get": + +type ProjectsLocationsBlockchainNodesGetCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// Get: Gets details of a single blockchain node. +// +// - name: The fully qualified name of the blockchain node to fetch. +// e.g. +// `projects/my-project/locations/us-central1/blockchainNodes/my-node`. +func (r *ProjectsLocationsBlockchainNodesService) Get(name string) *ProjectsLocationsBlockchainNodesGetCall { + c := &ProjectsLocationsBlockchainNodesGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsBlockchainNodesGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsBlockchainNodesGetCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsBlockchainNodesGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsBlockchainNodesGetCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsBlockchainNodesGetCall) Context(ctx context.Context) *ProjectsLocationsBlockchainNodesGetCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsBlockchainNodesGetCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsBlockchainNodesGetCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "blockchainnodeengine.projects.locations.blockchainNodes.get" call. +// Exactly one of *BlockchainNode or error will be non-nil. Any non-2xx +// status code is an error. Response headers are in either +// *BlockchainNode.ServerResponse.Header or (if a response was returned +// at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsBlockchainNodesGetCall) Do(opts ...googleapi.CallOption) (*BlockchainNode, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &BlockchainNode{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Gets details of a single blockchain node.", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes/{blockchainNodesId}", + // "httpMethod": "GET", + // "id": "blockchainnodeengine.projects.locations.blockchainNodes.get", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "Required. The fully qualified name of the blockchain node to fetch. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/blockchainNodes/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1/{+name}", + // "response": { + // "$ref": "BlockchainNode" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "blockchainnodeengine.projects.locations.blockchainNodes.list": + +type ProjectsLocationsBlockchainNodesListCall struct { + s *Service + parent string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// List: Lists blockchain nodes in a given project and location. +// +// - parent: Parent value for `ListNodesRequest`. +func (r *ProjectsLocationsBlockchainNodesService) List(parent string) *ProjectsLocationsBlockchainNodesListCall { + c := &ProjectsLocationsBlockchainNodesListCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + return c +} + +// Filter sets the optional parameter "filter": Filtering results. +func (c *ProjectsLocationsBlockchainNodesListCall) Filter(filter string) *ProjectsLocationsBlockchainNodesListCall { + c.urlParams_.Set("filter", filter) + return c +} + +// OrderBy sets the optional parameter "orderBy": Hint for how to order +// the results. +func (c *ProjectsLocationsBlockchainNodesListCall) OrderBy(orderBy string) *ProjectsLocationsBlockchainNodesListCall { + c.urlParams_.Set("orderBy", orderBy) + return c +} + +// PageSize sets the optional parameter "pageSize": Requested page size. +// Server may return fewer items than requested. If unspecified, server +// will pick an appropriate default. +func (c *ProjectsLocationsBlockchainNodesListCall) PageSize(pageSize int64) *ProjectsLocationsBlockchainNodesListCall { + c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) + return c +} + +// PageToken sets the optional parameter "pageToken": A token +// identifying a page of results the server should return. +func (c *ProjectsLocationsBlockchainNodesListCall) PageToken(pageToken string) *ProjectsLocationsBlockchainNodesListCall { + c.urlParams_.Set("pageToken", pageToken) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsBlockchainNodesListCall) Fields(s ...googleapi.Field) *ProjectsLocationsBlockchainNodesListCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsBlockchainNodesListCall) IfNoneMatch(entityTag string) *ProjectsLocationsBlockchainNodesListCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsBlockchainNodesListCall) Context(ctx context.Context) *ProjectsLocationsBlockchainNodesListCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsBlockchainNodesListCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsBlockchainNodesListCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/blockchainNodes") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "blockchainnodeengine.projects.locations.blockchainNodes.list" call. +// Exactly one of *ListBlockchainNodesResponse or error will be non-nil. +// Any non-2xx status code is an error. Response headers are in either +// *ListBlockchainNodesResponse.ServerResponse.Header or (if a response +// was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsBlockchainNodesListCall) Do(opts ...googleapi.CallOption) (*ListBlockchainNodesResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &ListBlockchainNodesResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Lists blockchain nodes in a given project and location.", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes", + // "httpMethod": "GET", + // "id": "blockchainnodeengine.projects.locations.blockchainNodes.list", + // "parameterOrder": [ + // "parent" + // ], + // "parameters": { + // "filter": { + // "description": "Filtering results.", + // "location": "query", + // "type": "string" + // }, + // "orderBy": { + // "description": "Hint for how to order the results.", + // "location": "query", + // "type": "string" + // }, + // "pageSize": { + // "description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + // "format": "int32", + // "location": "query", + // "type": "integer" + // }, + // "pageToken": { + // "description": "A token identifying a page of results the server should return.", + // "location": "query", + // "type": "string" + // }, + // "parent": { + // "description": "Required. Parent value for `ListNodesRequest`.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1/{+parent}/blockchainNodes", + // "response": { + // "$ref": "ListBlockchainNodesResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// Pages invokes f for each page of results. +// A non-nil error returned from f will halt the iteration. +// The provided context supersedes any context provided to the Context method. +func (c *ProjectsLocationsBlockchainNodesListCall) Pages(ctx context.Context, f func(*ListBlockchainNodesResponse) error) error { + c.ctx_ = ctx + defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point + for { + x, err := c.Do() + if err != nil { + return err + } + if err := f(x); err != nil { + return err + } + if x.NextPageToken == "" { + return nil + } + c.PageToken(x.NextPageToken) + } +} + +// method id "blockchainnodeengine.projects.locations.blockchainNodes.patch": + +type ProjectsLocationsBlockchainNodesPatchCall struct { + s *Service + name string + blockchainnode *BlockchainNode + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Patch: Updates the parameters of a single blockchain node. +// +// - name: Output only. The fully qualified name of the blockchain node. +// e.g. +// `projects/my-project/locations/us-central1/blockchainNodes/my-node`. +func (r *ProjectsLocationsBlockchainNodesService) Patch(name string, blockchainnode *BlockchainNode) *ProjectsLocationsBlockchainNodesPatchCall { + c := &ProjectsLocationsBlockchainNodesPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + c.blockchainnode = blockchainnode + return c +} + +// RequestId sets the optional parameter "requestId": 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). +func (c *ProjectsLocationsBlockchainNodesPatchCall) RequestId(requestId string) *ProjectsLocationsBlockchainNodesPatchCall { + c.urlParams_.Set("requestId", requestId) + return c +} + +// UpdateMask sets the optional parameter "updateMask": Required. Field +// mask is used to specify the fields to be overwritten in the +// Blockchain node 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. +func (c *ProjectsLocationsBlockchainNodesPatchCall) UpdateMask(updateMask string) *ProjectsLocationsBlockchainNodesPatchCall { + c.urlParams_.Set("updateMask", updateMask) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsBlockchainNodesPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsBlockchainNodesPatchCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsBlockchainNodesPatchCall) Context(ctx context.Context) *ProjectsLocationsBlockchainNodesPatchCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsBlockchainNodesPatchCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsBlockchainNodesPatchCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.blockchainnode) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("PATCH", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "blockchainnodeengine.projects.locations.blockchainNodes.patch" call. +// Exactly one of *Operation or error will be non-nil. Any non-2xx +// status code is an error. Response headers are in either +// *Operation.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified +// to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsBlockchainNodesPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Operation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Updates the parameters of a single blockchain node.", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes/{blockchainNodesId}", + // "httpMethod": "PATCH", + // "id": "blockchainnodeengine.projects.locations.blockchainNodes.patch", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "Output only. The fully qualified name of the blockchain node. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/blockchainNodes/[^/]+$", + // "required": true, + // "type": "string" + // }, + // "requestId": { + // "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + // "location": "query", + // "type": "string" + // }, + // "updateMask": { + // "description": "Required. Field mask is used to specify the fields to be overwritten in the Blockchain node resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + // "format": "google-fieldmask", + // "location": "query", + // "type": "string" + // } + // }, + // "path": "v1/{+name}", + // "request": { + // "$ref": "BlockchainNode" + // }, + // "response": { + // "$ref": "Operation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "blockchainnodeengine.projects.locations.operations.cancel": + +type ProjectsLocationsOperationsCancelCall struct { + s *Service + name string + canceloperationrequest *CancelOperationRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Cancel: 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`. +// +// - name: The name of the operation resource to be cancelled. +func (r *ProjectsLocationsOperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *ProjectsLocationsOperationsCancelCall { + c := &ProjectsLocationsOperationsCancelCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + c.canceloperationrequest = canceloperationrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsCancelCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsOperationsCancelCall) Context(ctx context.Context) *ProjectsLocationsOperationsCancelCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsOperationsCancelCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsOperationsCancelCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.canceloperationrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}:cancel") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "blockchainnodeengine.projects.locations.operations.cancel" call. +// Exactly one of *GoogleProtobufEmpty or error will be non-nil. Any +// non-2xx status code is an error. Response headers are in either +// *GoogleProtobufEmpty.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsOperationsCancelCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleProtobufEmpty{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", + // "httpMethod": "POST", + // "id": "blockchainnodeengine.projects.locations.operations.cancel", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "The name of the operation resource to be cancelled.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1/{+name}:cancel", + // "request": { + // "$ref": "CancelOperationRequest" + // }, + // "response": { + // "$ref": "GoogleProtobufEmpty" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "blockchainnodeengine.projects.locations.operations.delete": + +type ProjectsLocationsOperationsDeleteCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Delete: 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`. +// +// - name: The name of the operation resource to be deleted. +func (r *ProjectsLocationsOperationsService) Delete(name string) *ProjectsLocationsOperationsDeleteCall { + c := &ProjectsLocationsOperationsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsOperationsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsDeleteCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsOperationsDeleteCall) Context(ctx context.Context) *ProjectsLocationsOperationsDeleteCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsOperationsDeleteCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsOperationsDeleteCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("DELETE", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "blockchainnodeengine.projects.locations.operations.delete" call. +// Exactly one of *GoogleProtobufEmpty or error will be non-nil. Any +// non-2xx status code is an error. Response headers are in either +// *GoogleProtobufEmpty.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleProtobufEmpty{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + // "httpMethod": "DELETE", + // "id": "blockchainnodeengine.projects.locations.operations.delete", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "The name of the operation resource to be deleted.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1/{+name}", + // "response": { + // "$ref": "GoogleProtobufEmpty" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "blockchainnodeengine.projects.locations.operations.get": + +type ProjectsLocationsOperationsGetCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// Get: 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. +// +// - name: The name of the operation resource. +func (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall { + c := &ProjectsLocationsOperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsGetCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsGetCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsOperationsGetCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsOperationsGetCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsOperationsGetCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "blockchainnodeengine.projects.locations.operations.get" call. +// Exactly one of *Operation or error will be non-nil. Any non-2xx +// status code is an error. Response headers are in either +// *Operation.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified +// to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Operation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + // "httpMethod": "GET", + // "id": "blockchainnodeengine.projects.locations.operations.get", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "The name of the operation resource.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1/{+name}", + // "response": { + // "$ref": "Operation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "blockchainnodeengine.projects.locations.operations.list": + +type ProjectsLocationsOperationsListCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// List: Lists operations that match the specified filter in the +// request. If the server doesn't support this method, it returns +// `UNIMPLEMENTED`. +// +// - name: The name of the operation's parent resource. +func (r *ProjectsLocationsOperationsService) List(name string) *ProjectsLocationsOperationsListCall { + c := &ProjectsLocationsOperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Filter sets the optional parameter "filter": The standard list +// filter. +func (c *ProjectsLocationsOperationsListCall) Filter(filter string) *ProjectsLocationsOperationsListCall { + c.urlParams_.Set("filter", filter) + return c +} + +// PageSize sets the optional parameter "pageSize": The standard list +// page size. +func (c *ProjectsLocationsOperationsListCall) PageSize(pageSize int64) *ProjectsLocationsOperationsListCall { + c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) + return c +} + +// PageToken sets the optional parameter "pageToken": The standard list +// page token. +func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *ProjectsLocationsOperationsListCall { + c.urlParams_.Set("pageToken", pageToken) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsOperationsListCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsOperationsListCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsOperationsListCall) Context(ctx context.Context) *ProjectsLocationsOperationsListCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsOperationsListCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsOperationsListCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}/operations") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "blockchainnodeengine.projects.locations.operations.list" call. +// Exactly one of *ListOperationsResponse or error will be non-nil. Any +// non-2xx status code is an error. Response headers are in either +// *ListOperationsResponse.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *ProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &ListOperationsResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", + // "httpMethod": "GET", + // "id": "blockchainnodeengine.projects.locations.operations.list", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "filter": { + // "description": "The standard list filter.", + // "location": "query", + // "type": "string" + // }, + // "name": { + // "description": "The name of the operation's parent resource.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+$", + // "required": true, + // "type": "string" + // }, + // "pageSize": { + // "description": "The standard list page size.", + // "format": "int32", + // "location": "query", + // "type": "integer" + // }, + // "pageToken": { + // "description": "The standard list page token.", + // "location": "query", + // "type": "string" + // } + // }, + // "path": "v1/{+name}/operations", + // "response": { + // "$ref": "ListOperationsResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// Pages invokes f for each page of results. +// A non-nil error returned from f will halt the iteration. +// The provided context supersedes any context provided to the Context method. +func (c *ProjectsLocationsOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error { + c.ctx_ = ctx + defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point + for { + x, err := c.Do() + if err != nil { + return err + } + if err := f(x); err != nil { + return err + } + if x.NextPageToken == "" { + return nil + } + c.PageToken(x.NextPageToken) + } +} diff --git a/cloudfunctions/v2/cloudfunctions-api.json b/cloudfunctions/v2/cloudfunctions-api.json index bf202834cee..930040adbec 100644 --- a/cloudfunctions/v2/cloudfunctions-api.json +++ b/cloudfunctions/v2/cloudfunctions-api.json @@ -571,7 +571,7 @@ } } }, - "revision": "20230619", + "revision": "20230622", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -1698,10 +1698,6 @@ "description": "Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. eg. helloworld (no leading slash allowed)", "type": "string" }, - "invertRegex": { - "description": "Only trigger a build if the revision regex does NOT match the revision regex.", - "type": "boolean" - }, "projectId": { "description": "ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.", "type": "string" diff --git a/cloudfunctions/v2/cloudfunctions-gen.go b/cloudfunctions/v2/cloudfunctions-gen.go index c1c2625991a..7386d5430cf 100644 --- a/cloudfunctions/v2/cloudfunctions-gen.go +++ b/cloudfunctions/v2/cloudfunctions-gen.go @@ -1874,10 +1874,6 @@ type RepoSource struct { // execution. eg. helloworld (no leading slash allowed) Dir string `json:"dir,omitempty"` - // InvertRegex: Only trigger a build if the revision regex does NOT - // match the revision regex. - InvertRegex bool `json:"invertRegex,omitempty"` - // ProjectId: ID of the project that owns the Cloud Source Repository. // If omitted, the project ID requesting the build is assumed. ProjectId string `json:"projectId,omitempty"` diff --git a/cloudfunctions/v2alpha/cloudfunctions-api.json b/cloudfunctions/v2alpha/cloudfunctions-api.json index 7fef33f5cd3..5c246d8c26c 100644 --- a/cloudfunctions/v2alpha/cloudfunctions-api.json +++ b/cloudfunctions/v2alpha/cloudfunctions-api.json @@ -571,7 +571,7 @@ } } }, - "revision": "20230619", + "revision": "20230622", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -1698,10 +1698,6 @@ "description": "Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. eg. helloworld (no leading slash allowed)", "type": "string" }, - "invertRegex": { - "description": "Only trigger a build if the revision regex does NOT match the revision regex.", - "type": "boolean" - }, "projectId": { "description": "ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.", "type": "string" diff --git a/cloudfunctions/v2alpha/cloudfunctions-gen.go b/cloudfunctions/v2alpha/cloudfunctions-gen.go index 168e09ee44d..1c0420b5165 100644 --- a/cloudfunctions/v2alpha/cloudfunctions-gen.go +++ b/cloudfunctions/v2alpha/cloudfunctions-gen.go @@ -1874,10 +1874,6 @@ type RepoSource struct { // execution. eg. helloworld (no leading slash allowed) Dir string `json:"dir,omitempty"` - // InvertRegex: Only trigger a build if the revision regex does NOT - // match the revision regex. - InvertRegex bool `json:"invertRegex,omitempty"` - // ProjectId: ID of the project that owns the Cloud Source Repository. // If omitted, the project ID requesting the build is assumed. ProjectId string `json:"projectId,omitempty"` diff --git a/cloudfunctions/v2beta/cloudfunctions-api.json b/cloudfunctions/v2beta/cloudfunctions-api.json index 9a4b32fbb1c..8c2be7c38da 100644 --- a/cloudfunctions/v2beta/cloudfunctions-api.json +++ b/cloudfunctions/v2beta/cloudfunctions-api.json @@ -571,7 +571,7 @@ } } }, - "revision": "20230619", + "revision": "20230622", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -1698,10 +1698,6 @@ "description": "Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. eg. helloworld (no leading slash allowed)", "type": "string" }, - "invertRegex": { - "description": "Only trigger a build if the revision regex does NOT match the revision regex.", - "type": "boolean" - }, "projectId": { "description": "ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.", "type": "string" diff --git a/cloudfunctions/v2beta/cloudfunctions-gen.go b/cloudfunctions/v2beta/cloudfunctions-gen.go index 23c728d8018..821607c0545 100644 --- a/cloudfunctions/v2beta/cloudfunctions-gen.go +++ b/cloudfunctions/v2beta/cloudfunctions-gen.go @@ -1874,10 +1874,6 @@ type RepoSource struct { // execution. eg. helloworld (no leading slash allowed) Dir string `json:"dir,omitempty"` - // InvertRegex: Only trigger a build if the revision regex does NOT - // match the revision regex. - InvertRegex bool `json:"invertRegex,omitempty"` - // ProjectId: ID of the project that owns the Cloud Source Repository. // If omitted, the project ID requesting the build is assumed. ProjectId string `json:"projectId,omitempty"` diff --git a/cloudsupport/v2/cloudsupport-api.json b/cloudsupport/v2/cloudsupport-api.json new file mode 100644 index 00000000000..0cc4f8c7b9a --- /dev/null +++ b/cloudsupport/v2/cloudsupport-api.json @@ -0,0 +1,1386 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." + } + } + } + }, + "basePath": "", + "baseUrl": "https://cloudsupport.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Cloud Support", + "description": "Manages Google Cloud technical support cases for Customer Care support offerings. ", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/support/docs/apis", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "cloudsupport:v2", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://cloudsupport.mtls.googleapis.com/", + "name": "cloudsupport", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "caseClassifications": { + "methods": { + "search": { + "description": "Retrieve valid classifications to be used when creating a support case. The classications are hierarchical, with each classification containing all levels of the hierarchy, separated by `\" \u003e \"`. For example `\"Technical Issue \u003e Compute \u003e Compute Engine\"`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail.", + "flatPath": "v2/caseClassifications:search", + "httpMethod": "GET", + "id": "cloudsupport.caseClassifications.search", + "parameterOrder": [], + "parameters": { + "pageSize": { + "description": "The maximum number of cases fetched with each request.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying the page of results to return. If unspecified, the first page is retrieved.", + "location": "query", + "type": "string" + }, + "query": { + "description": "An expression written in the Google Cloud filter language. If non-empty, then only cases whose fields match the filter are returned. If empty, then no messages are filtered out.", + "location": "query", + "type": "string" + } + }, + "path": "v2/caseClassifications:search", + "response": { + "$ref": "SearchCaseClassificationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "cases": { + "methods": { + "close": { + "description": "Close the specified case.", + "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}:close", + "httpMethod": "POST", + "id": "cloudsupport.cases.close", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the case resource to be closed.", + "location": "path", + "pattern": "^[^/]+/[^/]+/cases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:close", + "request": { + "$ref": "CloseCaseRequest" + }, + "response": { + "$ref": "Case" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Create a new case and associate it with the given Google Cloud Resource. The case object must have the following fields set: `display_name`, `description`, `classification`, and `priority`.", + "flatPath": "v2/{v2Id}/{v2Id1}/cases", + "httpMethod": "POST", + "id": "cloudsupport.cases.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the Google Cloud Resource under which the case should be created.", + "location": "path", + "pattern": "^[^/]+/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/cases", + "request": { + "$ref": "Case" + }, + "response": { + "$ref": "Case" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "escalate": { + "description": "Escalate a case. Escalating a case will initiate the Google Cloud Support escalation management process. This operation is only available to certain Customer Care tiers. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which tiers are able to perform escalations.", + "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}:escalate", + "httpMethod": "POST", + "id": "cloudsupport.cases.escalate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the Case resource to be escalated.", + "location": "path", + "pattern": "^[^/]+/[^/]+/cases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:escalate", + "request": { + "$ref": "EscalateCaseRequest" + }, + "response": { + "$ref": "Case" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieve the specified case.", + "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}", + "httpMethod": "GET", + "id": "cloudsupport.cases.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of a case to be retrieved.", + "location": "path", + "pattern": "^[^/]+/[^/]+/cases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Case" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Retrieve all cases under the specified parent. Note: Listing cases under an Organization returns only the cases directly parented by that organization. To retrieve all cases under an organization, including cases parented by projects under that organization, use `cases.search`.", + "flatPath": "v2/{v2Id}/{v2Id1}/cases", + "httpMethod": "GET", + "id": "cloudsupport.cases.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "An expression written in filter language. If non-empty, the query returns the cases that match the filter. Else, the query doesn't filter the cases. Filter expressions use the following fields with the operators equals (`=`) and `AND`: - `state`: The accepted values are `OPEN` or `CLOSED`. - `priority`: The accepted values are `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. Examples: - `state=CLOSED` - `state=OPEN AND creator.email=\"tester@example.com\"` - `state=OPEN AND (priority=P0 OR priority=P1)`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of cases fetched with each request. Defaults to 10.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying the page of results to return. If unspecified, the first page is retrieved.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The fully qualified name of parent resource to list cases under.", + "location": "path", + "pattern": "^[^/]+/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/cases", + "response": { + "$ref": "ListCasesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update the specified case. Only a subset of fields can be updated.", + "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}", + "httpMethod": "PATCH", + "id": "cloudsupport.cases.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name for the case.", + "location": "path", + "pattern": "^[^/]+/[^/]+/cases/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "A list of attributes of the case object that should be updated as part of this request. Supported values are `priority`, `display_name`, and `subscriber_email_addresses`. If no fields are specified, all supported fields are updated. WARNING: If you do not provide a field mask, then you might accidentally clear some fields. For example, if you leave the field mask empty and do not provide a value for `subscriber_email_addresses`, then `subscriber_email_addresses` is updated to empty.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "Case" + }, + "response": { + "$ref": "Case" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "search": { + "description": "Search cases using the specified query.", + "flatPath": "v2/{v2Id}/{v2Id1}/cases:search", + "httpMethod": "GET", + "id": "cloudsupport.cases.search", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of cases fetched with each request. The default page size is 10.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying the page of results to return. If unspecified, the first page is retrieved.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "The fully qualified name of parent resource to search cases under.", + "location": "path", + "pattern": "^[^/]+/[^/]+$", + "required": true, + "type": "string" + }, + "query": { + "description": "An expression written in filter language. A query uses the following fields with the operators equals (`=`) and `AND`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: The accepted values are `OPEN` or `CLOSED`. - `priority`: The accepted values are `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. - `billingAccount`: A billing account in the form `billingAccounts/` 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\u003e\"2020-01-01T00:00:00-05:00\"`. `update_time` only supports the greater than operator (`\u003e`). Examples: - `organization=\"organizations/123456789\"` - `project=\"projects/my-project-id\"` - `project=\"projects/123456789\"` - `billing_account=\"billingAccounts/123456-A0B0C0-CUZ789\"` - `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" + } + }, + "path": "v2/{+parent}/cases:search", + "response": { + "$ref": "SearchCasesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "attachments": { + "methods": { + "list": { + "description": "Retrieve all attachments associated with a support case.", + "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}/attachments", + "httpMethod": "GET", + "id": "cloudsupport.cases.attachments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of attachments fetched with each request. If not provided, the default is 10. The maximum page size that will be returned is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying the page of results to return. If unspecified, the first page is retrieved.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of Case object for which attachments should be listed.", + "location": "path", + "pattern": "^[^/]+/[^/]+/cases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/attachments", + "response": { + "$ref": "ListAttachmentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "comments": { + "methods": { + "create": { + "description": "Add a new comment to the specified Case. The comment object must have the following fields set: body.", + "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}/comments", + "httpMethod": "POST", + "id": "cloudsupport.cases.comments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of Case to which this comment should be added.", + "location": "path", + "pattern": "^[^/]+/[^/]+/cases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/comments", + "request": { + "$ref": "Comment" + }, + "response": { + "$ref": "Comment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Retrieve all Comments associated with the Case object.", + "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}/comments", + "httpMethod": "GET", + "id": "cloudsupport.cases.comments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of comments fetched with each request. Defaults to 10.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying the page of results to return. If unspecified, the first page is retrieved.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of Case object for which comments should be listed.", + "location": "path", + "pattern": "^[^/]+/[^/]+/cases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/comments", + "response": { + "$ref": "ListCommentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "media": { + "methods": { + "download": { + "description": "Download a file attachment on a case. Note: HTTP requests must append \"?alt=media\" to the URL.", + "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}/attachments/{attachmentsId}:download", + "httpMethod": "GET", + "id": "cloudsupport.media.download", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the attachment to be downloaded.", + "location": "path", + "pattern": "^[^/]+/[^/]+/cases/[^/]+/attachments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:download", + "response": { + "$ref": "Media" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "supportsMediaDownload": true, + "useMediaDownloadService": true + }, + "upload": { + "description": "Create a file attachment on a case or Cloud resource. The attachment object must have the following fields set: filename.", + "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}/attachments", + "httpMethod": "POST", + "id": "cloudsupport.media.upload", + "mediaUpload": { + "accept": [ + "*/*" + ], + "protocols": { + "simple": { + "multipart": true, + "path": "/upload/v2/{+parent}/attachments" + } + } + }, + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the case (or case parent) to which the attachment should be attached.", + "location": "path", + "pattern": "^[^/]+/[^/]+/cases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/attachments", + "request": { + "$ref": "CreateAttachmentRequest" + }, + "response": { + "$ref": "Attachment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "supportsMediaUpload": true + } + } + } + }, + "revision": "20230626", + "rootUrl": "https://cloudsupport.googleapis.com/", + "schemas": { + "Actor": { + "description": "An object containing information about the effective user and authenticated principal responsible for an action.", + "id": "Actor", + "properties": { + "displayName": { + "description": "The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.", + "type": "string" + }, + "email": { + "description": "The email address of the actor. If not provided, it is inferred from credentials supplied during case creation. If the authenticated principal does not have an email address, one must be provided. When a name is provided, an email must also be provided. This will be obfuscated if the user is a Google Support agent.", + "type": "string" + }, + "googleSupport": { + "description": "Output only. Whether the actor is a Google support actor.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, + "Attachment": { + "description": "Represents a file attached to a support case.", + "id": "Attachment", + "properties": { + "createTime": { + "description": "Output only. The time at which the attachment was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "creator": { + "$ref": "Actor", + "description": "Output only. The user who uploaded the attachment. Note, the name and email will be obfuscated if the attachment was uploaded by Google support.", + "readOnly": true + }, + "filename": { + "description": "The filename of the attachment (e.g. `\"graph.jpg\"`).", + "type": "string" + }, + "mimeType": { + "description": "Output only. The MIME type of the attachment (e.g. text/plain).", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the attachment.", + "readOnly": true, + "type": "string" + }, + "sizeBytes": { + "description": "Output only. The size of the attachment in bytes.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Blobstore2Info": { + "description": "# gdata.* are outside protos with mising documentation", + "id": "Blobstore2Info", + "properties": { + "blobGeneration": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "int64", + "type": "string" + }, + "blobId": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "string" + }, + "downloadReadHandle": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "byte", + "type": "string" + }, + "readToken": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "string" + }, + "uploadMetadataContainer": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "Case": { + "description": "A support case.", + "id": "Case", + "properties": { + "classification": { + "$ref": "CaseClassification", + "description": "The issue classification applicable to this case." + }, + "contactEmail": { + "description": "A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time this case was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "creator": { + "$ref": "Actor", + "description": "The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support." + }, + "description": { + "description": "A broad description of the issue.", + "type": "string" + }, + "displayName": { + "description": "The short summary of the issue reported in this case.", + "type": "string" + }, + "escalated": { + "description": "Whether the case is currently escalated.", + "type": "boolean" + }, + "languageCode": { + "description": "The language the user has requested to receive support in. This should be a BCP 47 language code (e.g., `\"en\"`, `\"zh-CN\"`, `\"zh-TW\"`, `\"ja\"`, `\"ko\"`). If no language or an unsupported language is specified, this field defaults to English (en). Language selection during case creation may affect your available support options. For a list of supported languages and their support working hours, see: https://cloud.google.com/support/docs/language-working-hours", + "type": "string" + }, + "name": { + "description": "The resource name for the case.", + "type": "string" + }, + "priority": { + "description": "The priority of this case.", + "enum": [ + "PRIORITY_UNSPECIFIED", + "P0", + "P1", + "P2", + "P3", + "P4" + ], + "enumDescriptions": [ + "Priority is undefined or has not been set yet.", + "Extreme impact on a production service. Service is hard down.", + "Critical impact on a production service. Service is currently unusable.", + "Severe impact on a production service. Service is usable but greatly impaired.", + "Medium impact on a production service. Service is available, but moderately impaired.", + "General questions or minor issues. Production service is fully available." + ], + "type": "string" + }, + "state": { + "description": "Output only. The current status of the support case.", + "enum": [ + "STATE_UNSPECIFIED", + "NEW", + "IN_PROGRESS_GOOGLE_SUPPORT", + "ACTION_REQUIRED", + "SOLUTION_PROVIDED", + "CLOSED" + ], + "enumDescriptions": [ + "Case is in an unknown state.", + "The case has been created but no one is assigned to work on it yet.", + "The case is currently being handled by Google support.", + "Google is waiting for a response.", + "A solution has been offered for the case, but it isn't yet closed.", + "The case has been resolved." + ], + "readOnly": true, + "type": "string" + }, + "subscriberEmailAddresses": { + "description": "The email addresses to receive updates on this case.", + "items": { + "type": "string" + }, + "type": "array" + }, + "testCase": { + "description": "Whether this case was created for internal API testing and should not be acted on by the support team.", + "type": "boolean" + }, + "timeZone": { + "description": "The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API.", + "type": "string" + }, + "updateTime": { + "description": "Output only. The time this case was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CaseClassification": { + "description": "A classification object with a product type and value.", + "id": "CaseClassification", + "properties": { + "displayName": { + "description": "A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field.", + "type": "string" + }, + "id": { + "description": "The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail.", + "type": "string" + } + }, + "type": "object" + }, + "CloseCaseRequest": { + "description": "The request message for the CloseCase endpoint.", + "id": "CloseCaseRequest", + "properties": {}, + "type": "object" + }, + "Comment": { + "description": "A comment associated with a support case.", + "id": "Comment", + "properties": { + "body": { + "description": "The full comment body. Maximum of 12800 characters. This can contain rich text syntax.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time when this comment was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "creator": { + "$ref": "Actor", + "description": "Output only. The user or Google Support agent created this comment.", + "readOnly": true + }, + "name": { + "description": "Output only. The resource name for the comment.", + "readOnly": true, + "type": "string" + }, + "plainTextBody": { + "description": "Output only. DEPRECATED. An automatically generated plain text version of body with all rich text syntax stripped.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CompositeMedia": { + "description": "# gdata.* are outside protos with mising documentation", + "id": "CompositeMedia", + "properties": { + "blobRef": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "byte", + "type": "string" + }, + "blobstore2Info": { + "$ref": "Blobstore2Info", + "description": "# gdata.* are outside protos with mising documentation" + }, + "cosmoBinaryReference": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "byte", + "type": "string" + }, + "crc32cHash": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "uint32", + "type": "integer" + }, + "inline": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "byte", + "type": "string" + }, + "length": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "int64", + "type": "string" + }, + "md5Hash": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "byte", + "type": "string" + }, + "objectId": { + "$ref": "ObjectId", + "description": "# gdata.* are outside protos with mising documentation" + }, + "path": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "string" + }, + "referenceType": { + "description": "# gdata.* are outside protos with mising documentation", + "enum": [ + "PATH", + "BLOB_REF", + "INLINE", + "BIGSTORE_REF", + "COSMO_BINARY_REFERENCE" + ], + "enumDescriptions": [ + "# gdata.* are outside protos with mising documentation", + "# gdata.* are outside protos with mising documentation", + "# gdata.* are outside protos with mising documentation", + "# gdata.* are outside protos with mising documentation", + "# gdata.* are outside protos with mising documentation" + ], + "type": "string" + }, + "sha1Hash": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "ContentTypeInfo": { + "description": "# gdata.* are outside protos with mising documentation", + "id": "ContentTypeInfo", + "properties": { + "bestGuess": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "string" + }, + "fromBytes": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "string" + }, + "fromFileName": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "string" + }, + "fromHeader": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "string" + }, + "fromUrlPath": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "string" + } + }, + "type": "object" + }, + "CreateAttachmentRequest": { + "description": "The request message for the CreateAttachment endpoint.", + "id": "CreateAttachmentRequest", + "properties": { + "attachment": { + "$ref": "Attachment", + "description": "Required. The attachment to be created." + } + }, + "type": "object" + }, + "DiffChecksumsResponse": { + "description": "# gdata.* are outside protos with mising documentation", + "id": "DiffChecksumsResponse", + "properties": { + "checksumsLocation": { + "$ref": "CompositeMedia", + "description": "# gdata.* are outside protos with mising documentation" + }, + "chunkSizeBytes": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "int64", + "type": "string" + }, + "objectLocation": { + "$ref": "CompositeMedia", + "description": "# gdata.* are outside protos with mising documentation" + }, + "objectSizeBytes": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "int64", + "type": "string" + }, + "objectVersion": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "string" + } + }, + "type": "object" + }, + "DiffDownloadResponse": { + "description": "# gdata.* are outside protos with mising documentation", + "id": "DiffDownloadResponse", + "properties": { + "objectLocation": { + "$ref": "CompositeMedia", + "description": "# gdata.* are outside protos with mising documentation" + } + }, + "type": "object" + }, + "DiffUploadRequest": { + "description": "# gdata.* are outside protos with mising documentation", + "id": "DiffUploadRequest", + "properties": { + "checksumsInfo": { + "$ref": "CompositeMedia", + "description": "# gdata.* are outside protos with mising documentation" + }, + "objectInfo": { + "$ref": "CompositeMedia", + "description": "# gdata.* are outside protos with mising documentation" + }, + "objectVersion": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "string" + } + }, + "type": "object" + }, + "DiffUploadResponse": { + "description": "# gdata.* are outside protos with mising documentation", + "id": "DiffUploadResponse", + "properties": { + "objectVersion": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "string" + }, + "originalObject": { + "$ref": "CompositeMedia", + "description": "# gdata.* are outside protos with mising documentation" + } + }, + "type": "object" + }, + "DiffVersionResponse": { + "description": "# gdata.* are outside protos with mising documentation", + "id": "DiffVersionResponse", + "properties": { + "objectSizeBytes": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "int64", + "type": "string" + }, + "objectVersion": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "string" + } + }, + "type": "object" + }, + "DownloadParameters": { + "description": "# gdata.* are outside protos with mising documentation", + "id": "DownloadParameters", + "properties": { + "allowGzipCompression": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "boolean" + }, + "ignoreRange": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "boolean" + } + }, + "type": "object" + }, + "EscalateCaseRequest": { + "description": "The request message for the EscalateCase endpoint.", + "id": "EscalateCaseRequest", + "properties": { + "escalation": { + "$ref": "Escalation", + "description": "The escalation object to be sent with the escalation request." + } + }, + "type": "object" + }, + "Escalation": { + "description": "An escalation of a support case.", + "id": "Escalation", + "properties": { + "justification": { + "description": "Required. A free text description to accompany the `reason` field above. Provides additional context on why the case is being escalated.", + "type": "string" + }, + "reason": { + "description": "Required. The reason why the Case is being escalated.", + "enum": [ + "REASON_UNSPECIFIED", + "RESOLUTION_TIME", + "TECHNICAL_EXPERTISE", + "BUSINESS_IMPACT" + ], + "enumDescriptions": [ + "The escalation reason is in an unknown state or has not been specified.", + "The case is taking too long to resolve.", + "The support agent does not have the expertise required to successfully resolve the issue.", + "The issue is having a significant business impact." + ], + "type": "string" + } + }, + "type": "object" + }, + "ListAttachmentsResponse": { + "description": "The response message for the ListAttachments endpoint.", + "id": "ListAttachmentsResponse", + "properties": { + "attachments": { + "description": "The list of attachments associated with the given case.", + "items": { + "$ref": "Attachment" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. This should be set in the `page_token` field of subsequent `cases.attachments.list` requests. If unspecified, there are no more results to retrieve.", + "type": "string" + } + }, + "type": "object" + }, + "ListCasesResponse": { + "description": "The response message for the ListCases endpoint.", + "id": "ListCasesResponse", + "properties": { + "cases": { + "description": "The list of cases associated with the Google Cloud Resource, after any filters have been applied.", + "items": { + "$ref": "Case" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. This should be set in the `page_token` field of the subsequent `ListCasesRequest` message that is issued. If unspecified, there are no more results to retrieve.", + "type": "string" + } + }, + "type": "object" + }, + "ListCommentsResponse": { + "description": "The response message for the ListComments endpoint.", + "id": "ListCommentsResponse", + "properties": { + "comments": { + "description": "The list of Comments associated with the given Case.", + "items": { + "$ref": "Comment" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. This should be set in the `page_token` field of subsequent `ListCommentsRequest` message that is issued. If unspecified, there are no more results to retrieve.", + "type": "string" + } + }, + "type": "object" + }, + "Media": { + "description": "# gdata.* are outside protos with mising documentation", + "id": "Media", + "properties": { + "algorithm": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "string" + }, + "bigstoreObjectRef": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "byte", + "type": "string" + }, + "blobRef": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "byte", + "type": "string" + }, + "blobstore2Info": { + "$ref": "Blobstore2Info", + "description": "# gdata.* are outside protos with mising documentation" + }, + "compositeMedia": { + "description": "# gdata.* are outside protos with mising documentation", + "items": { + "$ref": "CompositeMedia" + }, + "type": "array" + }, + "contentType": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "string" + }, + "contentTypeInfo": { + "$ref": "ContentTypeInfo", + "description": "# gdata.* are outside protos with mising documentation" + }, + "cosmoBinaryReference": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "byte", + "type": "string" + }, + "crc32cHash": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "uint32", + "type": "integer" + }, + "diffChecksumsResponse": { + "$ref": "DiffChecksumsResponse", + "description": "# gdata.* are outside protos with mising documentation" + }, + "diffDownloadResponse": { + "$ref": "DiffDownloadResponse", + "description": "# gdata.* are outside protos with mising documentation" + }, + "diffUploadRequest": { + "$ref": "DiffUploadRequest", + "description": "# gdata.* are outside protos with mising documentation" + }, + "diffUploadResponse": { + "$ref": "DiffUploadResponse", + "description": "# gdata.* are outside protos with mising documentation" + }, + "diffVersionResponse": { + "$ref": "DiffVersionResponse", + "description": "# gdata.* are outside protos with mising documentation" + }, + "downloadParameters": { + "$ref": "DownloadParameters", + "description": "# gdata.* are outside protos with mising documentation" + }, + "filename": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "string" + }, + "hash": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "string" + }, + "hashVerified": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "boolean" + }, + "inline": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "byte", + "type": "string" + }, + "isPotentialRetry": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "boolean" + }, + "length": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "int64", + "type": "string" + }, + "md5Hash": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "byte", + "type": "string" + }, + "mediaId": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "byte", + "type": "string" + }, + "objectId": { + "$ref": "ObjectId", + "description": "# gdata.* are outside protos with mising documentation" + }, + "path": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "string" + }, + "referenceType": { + "description": "# gdata.* are outside protos with mising documentation", + "enum": [ + "PATH", + "BLOB_REF", + "INLINE", + "GET_MEDIA", + "COMPOSITE_MEDIA", + "BIGSTORE_REF", + "DIFF_VERSION_RESPONSE", + "DIFF_CHECKSUMS_RESPONSE", + "DIFF_DOWNLOAD_RESPONSE", + "DIFF_UPLOAD_REQUEST", + "DIFF_UPLOAD_RESPONSE", + "COSMO_BINARY_REFERENCE", + "ARBITRARY_BYTES" + ], + "enumDescriptions": [ + "# gdata.* are outside protos with mising documentation", + "# gdata.* are outside protos with mising documentation", + "# gdata.* are outside protos with mising documentation", + "# gdata.* are outside protos with mising documentation", + "# gdata.* are outside protos with mising documentation", + "# gdata.* are outside protos with mising documentation", + "# gdata.* are outside protos with mising documentation", + "# gdata.* are outside protos with mising documentation", + "# gdata.* are outside protos with mising documentation", + "# gdata.* are outside protos with mising documentation", + "# gdata.* are outside protos with mising documentation", + "# gdata.* are outside protos with mising documentation", + "# gdata.* are outside protos with mising documentation" + ], + "type": "string" + }, + "sha1Hash": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "byte", + "type": "string" + }, + "sha256Hash": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "byte", + "type": "string" + }, + "timestamp": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "uint64", + "type": "string" + }, + "token": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "string" + } + }, + "type": "object" + }, + "ObjectId": { + "description": "# gdata.* are outside protos with mising documentation", + "id": "ObjectId", + "properties": { + "bucketName": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "string" + }, + "generation": { + "description": "# gdata.* are outside protos with mising documentation", + "format": "int64", + "type": "string" + }, + "objectName": { + "description": "# gdata.* are outside protos with mising documentation", + "type": "string" + } + }, + "type": "object" + }, + "SearchCaseClassificationsResponse": { + "description": "The response message for SearchCaseClassifications endpoint.", + "id": "SearchCaseClassificationsResponse", + "properties": { + "caseClassifications": { + "description": "The classifications retrieved.", + "items": { + "$ref": "CaseClassification" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. This should be set in the `page_token` field of subsequent `SearchCaseClassificationsRequest` message that is issued. If unspecified, there are no more results to retrieve.", + "type": "string" + } + }, + "type": "object" + }, + "SearchCasesResponse": { + "description": "The response message for the SearchCases endpoint.", + "id": "SearchCasesResponse", + "properties": { + "cases": { + "description": "The list of cases associated with the Google Cloud Resource, after any filters have been applied.", + "items": { + "$ref": "Case" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. This should be set in the `page_token` field of subsequent `SearchCaseRequest` message that is issued. If unspecified, there are no more results to retrieve.", + "type": "string" + } + }, + "type": "object" + }, + "WorkflowOperationMetadata": { + "description": "Metadata about the operation. Used to lookup the current status.", + "id": "WorkflowOperationMetadata", + "properties": { + "namespace": { + "description": "The namespace that the job was scheduled in. Must be included in the workflow metadata so the workflow status can be retrieved.", + "type": "string" + }, + "operationAction": { + "description": "The type of action the operation is classified as.", + "enum": [ + "OPERATION_ACTION_UNSPECIFIED", + "CREATE_SUPPORT_ACCOUNT", + "UPDATE_SUPPORT_ACCOUNT", + "PURCHASE_SUPPORT_ACCOUNT" + ], + "enumDescriptions": [ + "Operation action is not specified.", + "Operation pertains to the creation of a new support account.", + "Operation pertains to the updating of an existing support account.", + "Operation pertains to the purchasing of a support plan that may either create or update a support account." + ], + "type": "string" + }, + "workflowOperationType": { + "description": "Which version of the workflow service this operation came from.", + "enum": [ + "UNKNOWN_OPERATION_TYPE", + "WORKFLOWS_V1", + "WORKFLOWS_V2" + ], + "enumDescriptions": [ + "Unknown version.", + "Version 1.", + "Version 2." + ], + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Google Cloud Support API", + "version": "v2", + "version_module": true +} \ No newline at end of file diff --git a/cloudsupport/v2/cloudsupport-gen.go b/cloudsupport/v2/cloudsupport-gen.go new file mode 100644 index 00000000000..4d3ec564ac1 --- /dev/null +++ b/cloudsupport/v2/cloudsupport-gen.go @@ -0,0 +1,3718 @@ +// Copyright 2023 Google LLC. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +// Code generated file. DO NOT EDIT. + +// Package cloudsupport provides access to the Google Cloud Support API. +// +// For product documentation, see: https://cloud.google.com/support/docs/apis +// +// # Creating a client +// +// Usage example: +// +// import "google.golang.org/api/cloudsupport/v2" +// ... +// ctx := context.Background() +// cloudsupportService, err := cloudsupport.NewService(ctx) +// +// In this example, Google Application Default Credentials are used for authentication. +// +// For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials. +// +// # Other authentication options +// +// To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey: +// +// cloudsupportService, err := cloudsupport.NewService(ctx, option.WithAPIKey("AIza...")) +// +// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource: +// +// config := &oauth2.Config{...} +// // ... +// token, err := config.Exchange(ctx, ...) +// cloudsupportService, err := cloudsupport.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token))) +// +// See https://godoc.org/google.golang.org/api/option/ for details on options. +package cloudsupport // import "google.golang.org/api/cloudsupport/v2" + +import ( + "bytes" + "context" + "encoding/json" + "errors" + "fmt" + "io" + "net/http" + "net/url" + "strconv" + "strings" + + googleapi "google.golang.org/api/googleapi" + internal "google.golang.org/api/internal" + gensupport "google.golang.org/api/internal/gensupport" + option "google.golang.org/api/option" + internaloption "google.golang.org/api/option/internaloption" + htransport "google.golang.org/api/transport/http" +) + +// Always reference these packages, just in case the auto-generated code +// below doesn't. +var _ = bytes.NewBuffer +var _ = strconv.Itoa +var _ = fmt.Sprintf +var _ = json.NewDecoder +var _ = io.Copy +var _ = url.Parse +var _ = gensupport.MarshalJSON +var _ = googleapi.Version +var _ = errors.New +var _ = strings.Replace +var _ = context.Canceled +var _ = internaloption.WithDefaultEndpoint +var _ = internal.Version + +const apiId = "cloudsupport:v2" +const apiName = "cloudsupport" +const apiVersion = "v2" +const basePath = "https://cloudsupport.googleapis.com/" +const mtlsBasePath = "https://cloudsupport.mtls.googleapis.com/" + +// OAuth2 scopes used by this API. +const ( + // See, edit, configure, and delete your Google Cloud data and see the + // email address for your Google Account. + CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform" +) + +// NewService creates a new Service. +func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) { + scopesOption := internaloption.WithDefaultScopes( + "https://www.googleapis.com/auth/cloud-platform", + ) + // NOTE: prepend, so we don't override user-specified scopes. + opts = append([]option.ClientOption{scopesOption}, opts...) + opts = append(opts, internaloption.WithDefaultEndpoint(basePath)) + opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath)) + client, endpoint, err := htransport.NewClient(ctx, opts...) + if err != nil { + return nil, err + } + s, err := New(client) + if err != nil { + return nil, err + } + if endpoint != "" { + s.BasePath = endpoint + } + return s, nil +} + +// New creates a new Service. It uses the provided http.Client for requests. +// +// Deprecated: please use NewService instead. +// To provide a custom HTTP client, use option.WithHTTPClient. +// If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead. +func New(client *http.Client) (*Service, error) { + if client == nil { + return nil, errors.New("client is nil") + } + s := &Service{client: client, BasePath: basePath} + s.CaseClassifications = NewCaseClassificationsService(s) + s.Cases = NewCasesService(s) + s.Media = NewMediaService(s) + return s, nil +} + +type Service struct { + client *http.Client + BasePath string // API endpoint base URL + UserAgent string // optional additional User-Agent fragment + + CaseClassifications *CaseClassificationsService + + Cases *CasesService + + Media *MediaService +} + +func (s *Service) userAgent() string { + if s.UserAgent == "" { + return googleapi.UserAgent + } + return googleapi.UserAgent + " " + s.UserAgent +} + +func NewCaseClassificationsService(s *Service) *CaseClassificationsService { + rs := &CaseClassificationsService{s: s} + return rs +} + +type CaseClassificationsService struct { + s *Service +} + +func NewCasesService(s *Service) *CasesService { + rs := &CasesService{s: s} + rs.Attachments = NewCasesAttachmentsService(s) + rs.Comments = NewCasesCommentsService(s) + return rs +} + +type CasesService struct { + s *Service + + Attachments *CasesAttachmentsService + + Comments *CasesCommentsService +} + +func NewCasesAttachmentsService(s *Service) *CasesAttachmentsService { + rs := &CasesAttachmentsService{s: s} + return rs +} + +type CasesAttachmentsService struct { + s *Service +} + +func NewCasesCommentsService(s *Service) *CasesCommentsService { + rs := &CasesCommentsService{s: s} + return rs +} + +type CasesCommentsService struct { + s *Service +} + +func NewMediaService(s *Service) *MediaService { + rs := &MediaService{s: s} + return rs +} + +type MediaService struct { + s *Service +} + +// Actor: An object containing information about the effective user and +// authenticated principal responsible for an action. +type Actor struct { + // DisplayName: The name to display for the actor. If not provided, it + // is inferred from credentials supplied during case creation. When an + // email is provided, a display name must also be provided. This will be + // obfuscated if the user is a Google Support agent. + DisplayName string `json:"displayName,omitempty"` + + // Email: The email address of the actor. If not provided, it is + // inferred from credentials supplied during case creation. If the + // authenticated principal does not have an email address, one must be + // provided. When a name is provided, an email must also be provided. + // This will be obfuscated if the user is a Google Support agent. + Email string `json:"email,omitempty"` + + // GoogleSupport: Output only. Whether the actor is a Google support + // actor. + GoogleSupport bool `json:"googleSupport,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DisplayName") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DisplayName") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *Actor) MarshalJSON() ([]byte, error) { + type NoMethod Actor + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// Attachment: Represents a file attached to a support case. +type Attachment struct { + // CreateTime: Output only. The time at which the attachment was + // created. + CreateTime string `json:"createTime,omitempty"` + + // Creator: Output only. The user who uploaded the attachment. Note, the + // name and email will be obfuscated if the attachment was uploaded by + // Google support. + Creator *Actor `json:"creator,omitempty"` + + // Filename: The filename of the attachment (e.g. "graph.jpg"). + Filename string `json:"filename,omitempty"` + + // MimeType: Output only. The MIME type of the attachment (e.g. + // text/plain). + MimeType string `json:"mimeType,omitempty"` + + // Name: Output only. The resource name of the attachment. + Name string `json:"name,omitempty"` + + // SizeBytes: Output only. The size of the attachment in bytes. + SizeBytes int64 `json:"sizeBytes,omitempty,string"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "CreateTime") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CreateTime") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *Attachment) MarshalJSON() ([]byte, error) { + type NoMethod Attachment + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// Blobstore2Info: # gdata.* are outside protos with mising +// documentation +type Blobstore2Info struct { + // BlobGeneration: # gdata.* are outside protos with mising + // documentation + BlobGeneration int64 `json:"blobGeneration,omitempty,string"` + + // BlobId: # gdata.* are outside protos with mising documentation + BlobId string `json:"blobId,omitempty"` + + // DownloadReadHandle: # gdata.* are outside protos with mising + // documentation + DownloadReadHandle string `json:"downloadReadHandle,omitempty"` + + // ReadToken: # gdata.* are outside protos with mising documentation + ReadToken string `json:"readToken,omitempty"` + + // UploadMetadataContainer: # gdata.* are outside protos with mising + // documentation + UploadMetadataContainer string `json:"uploadMetadataContainer,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BlobGeneration") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BlobGeneration") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *Blobstore2Info) MarshalJSON() ([]byte, error) { + type NoMethod Blobstore2Info + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// Case: A support case. +type Case struct { + // Classification: The issue classification applicable to this case. + Classification *CaseClassification `json:"classification,omitempty"` + + // ContactEmail: A user-supplied email address to send case update + // notifications for. This should only be used in BYOID flows, where we + // cannot infer the user's email address directly from their EUCs. + ContactEmail string `json:"contactEmail,omitempty"` + + // CreateTime: Output only. The time this case was created. + CreateTime string `json:"createTime,omitempty"` + + // Creator: The user who created the case. Note: The name and email will + // be obfuscated if the case was created by Google Support. + Creator *Actor `json:"creator,omitempty"` + + // Description: A broad description of the issue. + Description string `json:"description,omitempty"` + + // DisplayName: The short summary of the issue reported in this case. + DisplayName string `json:"displayName,omitempty"` + + // Escalated: Whether the case is currently escalated. + Escalated bool `json:"escalated,omitempty"` + + // LanguageCode: The language the user has requested to receive support + // in. This should be a BCP 47 language code (e.g., "en", "zh-CN", + // "zh-TW", "ja", "ko"). If no language or an unsupported language + // is specified, this field defaults to English (en). Language selection + // during case creation may affect your available support options. For a + // list of supported languages and their support working hours, see: + // https://cloud.google.com/support/docs/language-working-hours + LanguageCode string `json:"languageCode,omitempty"` + + // Name: The resource name for the case. + Name string `json:"name,omitempty"` + + // Priority: The priority of this case. + // + // Possible values: + // "PRIORITY_UNSPECIFIED" - Priority is undefined or has not been set + // yet. + // "P0" - Extreme impact on a production service. Service is hard + // down. + // "P1" - Critical impact on a production service. Service is + // currently unusable. + // "P2" - Severe impact on a production service. Service is usable but + // greatly impaired. + // "P3" - Medium impact on a production service. Service is available, + // but moderately impaired. + // "P4" - General questions or minor issues. Production service is + // fully available. + Priority string `json:"priority,omitempty"` + + // State: Output only. The current status of the support case. + // + // Possible values: + // "STATE_UNSPECIFIED" - Case is in an unknown state. + // "NEW" - The case has been created but no one is assigned to work on + // it yet. + // "IN_PROGRESS_GOOGLE_SUPPORT" - The case is currently being handled + // by Google support. + // "ACTION_REQUIRED" - Google is waiting for a response. + // "SOLUTION_PROVIDED" - A solution has been offered for the case, but + // it isn't yet closed. + // "CLOSED" - The case has been resolved. + State string `json:"state,omitempty"` + + // SubscriberEmailAddresses: The email addresses to receive updates on + // this case. + SubscriberEmailAddresses []string `json:"subscriberEmailAddresses,omitempty"` + + // TestCase: Whether this case was created for internal API testing and + // should not be acted on by the support team. + TestCase bool `json:"testCase,omitempty"` + + // TimeZone: The timezone of the user who created the support case. It + // should be in a format IANA recognizes: + // https://www.iana.org/time-zones. There is no additional validation + // done by the API. + TimeZone string `json:"timeZone,omitempty"` + + // UpdateTime: Output only. The time this case was last updated. + UpdateTime string `json:"updateTime,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "Classification") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Classification") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *Case) MarshalJSON() ([]byte, error) { + type NoMethod Case + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CaseClassification: A classification object with a product type and +// value. +type CaseClassification struct { + // DisplayName: A display name for the classification. The display name + // is not static and can change. To uniquely and consistently identify + // classifications, use the `CaseClassification.id` field. + DisplayName string `json:"displayName,omitempty"` + + // Id: The unique ID for a classification. Must be specified for case + // creation. To retrieve valid classification IDs for case creation, use + // `caseClassifications.search`. Classification IDs returned by + // `caseClassifications.search` are guaranteed to be valid for at least + // 6 months. If a given classification is deactiveated, it will + // immediately stop being returned. After 6 months, `case.create` + // requests using the classification ID will fail. + Id string `json:"id,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DisplayName") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DisplayName") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CaseClassification) MarshalJSON() ([]byte, error) { + type NoMethod CaseClassification + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CloseCaseRequest: The request message for the CloseCase endpoint. +type CloseCaseRequest struct { +} + +// Comment: A comment associated with a support case. +type Comment struct { + // Body: The full comment body. Maximum of 12800 characters. This can + // contain rich text syntax. + Body string `json:"body,omitempty"` + + // CreateTime: Output only. The time when this comment was created. + CreateTime string `json:"createTime,omitempty"` + + // Creator: Output only. The user or Google Support agent created this + // comment. + Creator *Actor `json:"creator,omitempty"` + + // Name: Output only. The resource name for the comment. + Name string `json:"name,omitempty"` + + // PlainTextBody: Output only. DEPRECATED. An automatically generated + // plain text version of body with all rich text syntax stripped. + PlainTextBody string `json:"plainTextBody,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "Body") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Body") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *Comment) MarshalJSON() ([]byte, error) { + type NoMethod Comment + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CompositeMedia: # gdata.* are outside protos with mising +// documentation +type CompositeMedia struct { + // BlobRef: # gdata.* are outside protos with mising documentation + BlobRef string `json:"blobRef,omitempty"` + + // Blobstore2Info: # gdata.* are outside protos with mising + // documentation + Blobstore2Info *Blobstore2Info `json:"blobstore2Info,omitempty"` + + // CosmoBinaryReference: # gdata.* are outside protos with mising + // documentation + CosmoBinaryReference string `json:"cosmoBinaryReference,omitempty"` + + // Crc32cHash: # gdata.* are outside protos with mising documentation + Crc32cHash int64 `json:"crc32cHash,omitempty"` + + // Inline: # gdata.* are outside protos with mising documentation + Inline string `json:"inline,omitempty"` + + // Length: # gdata.* are outside protos with mising documentation + Length int64 `json:"length,omitempty,string"` + + // Md5Hash: # gdata.* are outside protos with mising documentation + Md5Hash string `json:"md5Hash,omitempty"` + + // ObjectId: # gdata.* are outside protos with mising documentation + ObjectId *ObjectId `json:"objectId,omitempty"` + + // Path: # gdata.* are outside protos with mising documentation + Path string `json:"path,omitempty"` + + // ReferenceType: # gdata.* are outside protos with mising documentation + // + // Possible values: + // "PATH" - # gdata.* are outside protos with mising documentation + // "BLOB_REF" - # gdata.* are outside protos with mising documentation + // "INLINE" - # gdata.* are outside protos with mising documentation + // "BIGSTORE_REF" - # gdata.* are outside protos with mising + // documentation + // "COSMO_BINARY_REFERENCE" - # gdata.* are outside protos with mising + // documentation + ReferenceType string `json:"referenceType,omitempty"` + + // Sha1Hash: # gdata.* are outside protos with mising documentation + Sha1Hash string `json:"sha1Hash,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BlobRef") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BlobRef") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CompositeMedia) MarshalJSON() ([]byte, error) { + type NoMethod CompositeMedia + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// ContentTypeInfo: # gdata.* are outside protos with mising +// documentation +type ContentTypeInfo struct { + // BestGuess: # gdata.* are outside protos with mising documentation + BestGuess string `json:"bestGuess,omitempty"` + + // FromBytes: # gdata.* are outside protos with mising documentation + FromBytes string `json:"fromBytes,omitempty"` + + // FromFileName: # gdata.* are outside protos with mising documentation + FromFileName string `json:"fromFileName,omitempty"` + + // FromHeader: # gdata.* are outside protos with mising documentation + FromHeader string `json:"fromHeader,omitempty"` + + // FromUrlPath: # gdata.* are outside protos with mising documentation + FromUrlPath string `json:"fromUrlPath,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BestGuess") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BestGuess") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ContentTypeInfo) MarshalJSON() ([]byte, error) { + type NoMethod ContentTypeInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// CreateAttachmentRequest: The request message for the CreateAttachment +// endpoint. +type CreateAttachmentRequest struct { + // Attachment: Required. The attachment to be created. + Attachment *Attachment `json:"attachment,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Attachment") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Attachment") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CreateAttachmentRequest) MarshalJSON() ([]byte, error) { + type NoMethod CreateAttachmentRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// DiffChecksumsResponse: # gdata.* are outside protos with mising +// documentation +type DiffChecksumsResponse struct { + // ChecksumsLocation: # gdata.* are outside protos with mising + // documentation + ChecksumsLocation *CompositeMedia `json:"checksumsLocation,omitempty"` + + // ChunkSizeBytes: # gdata.* are outside protos with mising + // documentation + ChunkSizeBytes int64 `json:"chunkSizeBytes,omitempty,string"` + + // ObjectLocation: # gdata.* are outside protos with mising + // documentation + ObjectLocation *CompositeMedia `json:"objectLocation,omitempty"` + + // ObjectSizeBytes: # gdata.* are outside protos with mising + // documentation + ObjectSizeBytes int64 `json:"objectSizeBytes,omitempty,string"` + + // ObjectVersion: # gdata.* are outside protos with mising documentation + ObjectVersion string `json:"objectVersion,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ChecksumsLocation") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ChecksumsLocation") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *DiffChecksumsResponse) MarshalJSON() ([]byte, error) { + type NoMethod DiffChecksumsResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// DiffDownloadResponse: # gdata.* are outside protos with mising +// documentation +type DiffDownloadResponse struct { + // ObjectLocation: # gdata.* are outside protos with mising + // documentation + ObjectLocation *CompositeMedia `json:"objectLocation,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ObjectLocation") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ObjectLocation") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *DiffDownloadResponse) MarshalJSON() ([]byte, error) { + type NoMethod DiffDownloadResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// DiffUploadRequest: # gdata.* are outside protos with mising +// documentation +type DiffUploadRequest struct { + // ChecksumsInfo: # gdata.* are outside protos with mising documentation + ChecksumsInfo *CompositeMedia `json:"checksumsInfo,omitempty"` + + // ObjectInfo: # gdata.* are outside protos with mising documentation + ObjectInfo *CompositeMedia `json:"objectInfo,omitempty"` + + // ObjectVersion: # gdata.* are outside protos with mising documentation + ObjectVersion string `json:"objectVersion,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ChecksumsInfo") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ChecksumsInfo") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *DiffUploadRequest) MarshalJSON() ([]byte, error) { + type NoMethod DiffUploadRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// DiffUploadResponse: # gdata.* are outside protos with mising +// documentation +type DiffUploadResponse struct { + // ObjectVersion: # gdata.* are outside protos with mising documentation + ObjectVersion string `json:"objectVersion,omitempty"` + + // OriginalObject: # gdata.* are outside protos with mising + // documentation + OriginalObject *CompositeMedia `json:"originalObject,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ObjectVersion") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ObjectVersion") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *DiffUploadResponse) MarshalJSON() ([]byte, error) { + type NoMethod DiffUploadResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// DiffVersionResponse: # gdata.* are outside protos with mising +// documentation +type DiffVersionResponse struct { + // ObjectSizeBytes: # gdata.* are outside protos with mising + // documentation + ObjectSizeBytes int64 `json:"objectSizeBytes,omitempty,string"` + + // ObjectVersion: # gdata.* are outside protos with mising documentation + ObjectVersion string `json:"objectVersion,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ObjectSizeBytes") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ObjectSizeBytes") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *DiffVersionResponse) MarshalJSON() ([]byte, error) { + type NoMethod DiffVersionResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// DownloadParameters: # gdata.* are outside protos with mising +// documentation +type DownloadParameters struct { + // AllowGzipCompression: # gdata.* are outside protos with mising + // documentation + AllowGzipCompression bool `json:"allowGzipCompression,omitempty"` + + // IgnoreRange: # gdata.* are outside protos with mising documentation + IgnoreRange bool `json:"ignoreRange,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "AllowGzipCompression") to unconditionally include in API requests. + // By default, fields with empty or default values are omitted from API + // requests. However, any non-pointer, non-interface field appearing in + // ForceSendFields will be sent to the server regardless of whether the + // field is empty or not. This may be used to include empty fields in + // Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "AllowGzipCompression") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *DownloadParameters) MarshalJSON() ([]byte, error) { + type NoMethod DownloadParameters + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// EscalateCaseRequest: The request message for the EscalateCase +// endpoint. +type EscalateCaseRequest struct { + // Escalation: The escalation object to be sent with the escalation + // request. + Escalation *Escalation `json:"escalation,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Escalation") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Escalation") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *EscalateCaseRequest) MarshalJSON() ([]byte, error) { + type NoMethod EscalateCaseRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// Escalation: An escalation of a support case. +type Escalation struct { + // Justification: Required. A free text description to accompany the + // `reason` field above. Provides additional context on why the case is + // being escalated. + Justification string `json:"justification,omitempty"` + + // Reason: Required. The reason why the Case is being escalated. + // + // Possible values: + // "REASON_UNSPECIFIED" - The escalation reason is in an unknown state + // or has not been specified. + // "RESOLUTION_TIME" - The case is taking too long to resolve. + // "TECHNICAL_EXPERTISE" - The support agent does not have the + // expertise required to successfully resolve the issue. + // "BUSINESS_IMPACT" - The issue is having a significant business + // impact. + Reason string `json:"reason,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Justification") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Justification") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *Escalation) MarshalJSON() ([]byte, error) { + type NoMethod Escalation + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// ListAttachmentsResponse: The response message for the ListAttachments +// endpoint. +type ListAttachmentsResponse struct { + // Attachments: The list of attachments associated with the given case. + Attachments []*Attachment `json:"attachments,omitempty"` + + // NextPageToken: A token to retrieve the next page of results. This + // should be set in the `page_token` field of subsequent + // `cases.attachments.list` requests. If unspecified, there are no more + // results to retrieve. + NextPageToken string `json:"nextPageToken,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "Attachments") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Attachments") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ListAttachmentsResponse) MarshalJSON() ([]byte, error) { + type NoMethod ListAttachmentsResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// ListCasesResponse: The response message for the ListCases endpoint. +type ListCasesResponse struct { + // Cases: The list of cases associated with the Google Cloud Resource, + // after any filters have been applied. + Cases []*Case `json:"cases,omitempty"` + + // NextPageToken: A token to retrieve the next page of results. This + // should be set in the `page_token` field of the subsequent + // `ListCasesRequest` message that is issued. If unspecified, there are + // no more results to retrieve. + NextPageToken string `json:"nextPageToken,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "Cases") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Cases") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ListCasesResponse) MarshalJSON() ([]byte, error) { + type NoMethod ListCasesResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// ListCommentsResponse: The response message for the ListComments +// endpoint. +type ListCommentsResponse struct { + // Comments: The list of Comments associated with the given Case. + Comments []*Comment `json:"comments,omitempty"` + + // NextPageToken: A token to retrieve the next page of results. This + // should be set in the `page_token` field of subsequent + // `ListCommentsRequest` message that is issued. If unspecified, there + // are no more results to retrieve. + NextPageToken string `json:"nextPageToken,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "Comments") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Comments") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ListCommentsResponse) MarshalJSON() ([]byte, error) { + type NoMethod ListCommentsResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// Media: # gdata.* are outside protos with mising documentation +type Media struct { + // Algorithm: # gdata.* are outside protos with mising documentation + Algorithm string `json:"algorithm,omitempty"` + + // BigstoreObjectRef: # gdata.* are outside protos with mising + // documentation + BigstoreObjectRef string `json:"bigstoreObjectRef,omitempty"` + + // BlobRef: # gdata.* are outside protos with mising documentation + BlobRef string `json:"blobRef,omitempty"` + + // Blobstore2Info: # gdata.* are outside protos with mising + // documentation + Blobstore2Info *Blobstore2Info `json:"blobstore2Info,omitempty"` + + // CompositeMedia: # gdata.* are outside protos with mising + // documentation + CompositeMedia []*CompositeMedia `json:"compositeMedia,omitempty"` + + // ContentType: # gdata.* are outside protos with mising documentation + ContentType string `json:"contentType,omitempty"` + + // ContentTypeInfo: # gdata.* are outside protos with mising + // documentation + ContentTypeInfo *ContentTypeInfo `json:"contentTypeInfo,omitempty"` + + // CosmoBinaryReference: # gdata.* are outside protos with mising + // documentation + CosmoBinaryReference string `json:"cosmoBinaryReference,omitempty"` + + // Crc32cHash: # gdata.* are outside protos with mising documentation + Crc32cHash int64 `json:"crc32cHash,omitempty"` + + // DiffChecksumsResponse: # gdata.* are outside protos with mising + // documentation + DiffChecksumsResponse *DiffChecksumsResponse `json:"diffChecksumsResponse,omitempty"` + + // DiffDownloadResponse: # gdata.* are outside protos with mising + // documentation + DiffDownloadResponse *DiffDownloadResponse `json:"diffDownloadResponse,omitempty"` + + // DiffUploadRequest: # gdata.* are outside protos with mising + // documentation + DiffUploadRequest *DiffUploadRequest `json:"diffUploadRequest,omitempty"` + + // DiffUploadResponse: # gdata.* are outside protos with mising + // documentation + DiffUploadResponse *DiffUploadResponse `json:"diffUploadResponse,omitempty"` + + // DiffVersionResponse: # gdata.* are outside protos with mising + // documentation + DiffVersionResponse *DiffVersionResponse `json:"diffVersionResponse,omitempty"` + + // DownloadParameters: # gdata.* are outside protos with mising + // documentation + DownloadParameters *DownloadParameters `json:"downloadParameters,omitempty"` + + // Filename: # gdata.* are outside protos with mising documentation + Filename string `json:"filename,omitempty"` + + // Hash: # gdata.* are outside protos with mising documentation + Hash string `json:"hash,omitempty"` + + // HashVerified: # gdata.* are outside protos with mising documentation + HashVerified bool `json:"hashVerified,omitempty"` + + // Inline: # gdata.* are outside protos with mising documentation + Inline string `json:"inline,omitempty"` + + // IsPotentialRetry: # gdata.* are outside protos with mising + // documentation + IsPotentialRetry bool `json:"isPotentialRetry,omitempty"` + + // Length: # gdata.* are outside protos with mising documentation + Length int64 `json:"length,omitempty,string"` + + // Md5Hash: # gdata.* are outside protos with mising documentation + Md5Hash string `json:"md5Hash,omitempty"` + + // MediaId: # gdata.* are outside protos with mising documentation + MediaId string `json:"mediaId,omitempty"` + + // ObjectId: # gdata.* are outside protos with mising documentation + ObjectId *ObjectId `json:"objectId,omitempty"` + + // Path: # gdata.* are outside protos with mising documentation + Path string `json:"path,omitempty"` + + // ReferenceType: # gdata.* are outside protos with mising documentation + // + // Possible values: + // "PATH" - # gdata.* are outside protos with mising documentation + // "BLOB_REF" - # gdata.* are outside protos with mising documentation + // "INLINE" - # gdata.* are outside protos with mising documentation + // "GET_MEDIA" - # gdata.* are outside protos with mising + // documentation + // "COMPOSITE_MEDIA" - # gdata.* are outside protos with mising + // documentation + // "BIGSTORE_REF" - # gdata.* are outside protos with mising + // documentation + // "DIFF_VERSION_RESPONSE" - # gdata.* are outside protos with mising + // documentation + // "DIFF_CHECKSUMS_RESPONSE" - # gdata.* are outside protos with + // mising documentation + // "DIFF_DOWNLOAD_RESPONSE" - # gdata.* are outside protos with mising + // documentation + // "DIFF_UPLOAD_REQUEST" - # gdata.* are outside protos with mising + // documentation + // "DIFF_UPLOAD_RESPONSE" - # gdata.* are outside protos with mising + // documentation + // "COSMO_BINARY_REFERENCE" - # gdata.* are outside protos with mising + // documentation + // "ARBITRARY_BYTES" - # gdata.* are outside protos with mising + // documentation + ReferenceType string `json:"referenceType,omitempty"` + + // Sha1Hash: # gdata.* are outside protos with mising documentation + Sha1Hash string `json:"sha1Hash,omitempty"` + + // Sha256Hash: # gdata.* are outside protos with mising documentation + Sha256Hash string `json:"sha256Hash,omitempty"` + + // Timestamp: # gdata.* are outside protos with mising documentation + Timestamp uint64 `json:"timestamp,omitempty,string"` + + // Token: # gdata.* are outside protos with mising documentation + Token string `json:"token,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "Algorithm") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Algorithm") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *Media) MarshalJSON() ([]byte, error) { + type NoMethod Media + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// ObjectId: # gdata.* are outside protos with mising documentation +type ObjectId struct { + // BucketName: # gdata.* are outside protos with mising documentation + BucketName string `json:"bucketName,omitempty"` + + // Generation: # gdata.* are outside protos with mising documentation + Generation int64 `json:"generation,omitempty,string"` + + // ObjectName: # gdata.* are outside protos with mising documentation + ObjectName string `json:"objectName,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BucketName") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BucketName") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ObjectId) MarshalJSON() ([]byte, error) { + type NoMethod ObjectId + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// SearchCaseClassificationsResponse: The response message for +// SearchCaseClassifications endpoint. +type SearchCaseClassificationsResponse struct { + // CaseClassifications: The classifications retrieved. + CaseClassifications []*CaseClassification `json:"caseClassifications,omitempty"` + + // NextPageToken: A token to retrieve the next page of results. This + // should be set in the `page_token` field of subsequent + // `SearchCaseClassificationsRequest` message that is issued. If + // unspecified, there are no more results to retrieve. + NextPageToken string `json:"nextPageToken,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "CaseClassifications") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CaseClassifications") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *SearchCaseClassificationsResponse) MarshalJSON() ([]byte, error) { + type NoMethod SearchCaseClassificationsResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// SearchCasesResponse: The response message for the SearchCases +// endpoint. +type SearchCasesResponse struct { + // Cases: The list of cases associated with the Google Cloud Resource, + // after any filters have been applied. + Cases []*Case `json:"cases,omitempty"` + + // NextPageToken: A token to retrieve the next page of results. This + // should be set in the `page_token` field of subsequent + // `SearchCaseRequest` message that is issued. If unspecified, there are + // no more results to retrieve. + NextPageToken string `json:"nextPageToken,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "Cases") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Cases") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *SearchCasesResponse) MarshalJSON() ([]byte, error) { + type NoMethod SearchCasesResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// WorkflowOperationMetadata: Metadata about the operation. Used to +// lookup the current status. +type WorkflowOperationMetadata struct { + // Namespace: The namespace that the job was scheduled in. Must be + // included in the workflow metadata so the workflow status can be + // retrieved. + Namespace string `json:"namespace,omitempty"` + + // OperationAction: The type of action the operation is classified as. + // + // Possible values: + // "OPERATION_ACTION_UNSPECIFIED" - Operation action is not specified. + // "CREATE_SUPPORT_ACCOUNT" - Operation pertains to the creation of a + // new support account. + // "UPDATE_SUPPORT_ACCOUNT" - Operation pertains to the updating of an + // existing support account. + // "PURCHASE_SUPPORT_ACCOUNT" - Operation pertains to the purchasing + // of a support plan that may either create or update a support account. + OperationAction string `json:"operationAction,omitempty"` + + // WorkflowOperationType: Which version of the workflow service this + // operation came from. + // + // Possible values: + // "UNKNOWN_OPERATION_TYPE" - Unknown version. + // "WORKFLOWS_V1" - Version 1. + // "WORKFLOWS_V2" - Version 2. + WorkflowOperationType string `json:"workflowOperationType,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Namespace") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Namespace") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *WorkflowOperationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod WorkflowOperationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// method id "cloudsupport.caseClassifications.search": + +type CaseClassificationsSearchCall struct { + s *Service + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// Search: Retrieve valid classifications to be used when creating a +// support case. The classications are hierarchical, with each +// classification containing all levels of the hierarchy, separated by +// " > ". For example "Technical Issue > Compute > Compute Engine". +// Classification IDs returned by `caseClassifications.search` are +// guaranteed to be valid for at least 6 months. If a given +// classification is deactiveated, it will immediately stop being +// returned. After 6 months, `case.create` requests using the +// classification ID will fail. +func (r *CaseClassificationsService) Search() *CaseClassificationsSearchCall { + c := &CaseClassificationsSearchCall{s: r.s, urlParams_: make(gensupport.URLParams)} + return c +} + +// PageSize sets the optional parameter "pageSize": The maximum number +// of cases fetched with each request. +func (c *CaseClassificationsSearchCall) PageSize(pageSize int64) *CaseClassificationsSearchCall { + c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) + return c +} + +// PageToken sets the optional parameter "pageToken": A token +// identifying the page of results to return. If unspecified, the first +// page is retrieved. +func (c *CaseClassificationsSearchCall) PageToken(pageToken string) *CaseClassificationsSearchCall { + c.urlParams_.Set("pageToken", pageToken) + return c +} + +// Query sets the optional parameter "query": An expression written in +// the Google Cloud filter language. If non-empty, then only cases whose +// fields match the filter are returned. If empty, then no messages are +// filtered out. +func (c *CaseClassificationsSearchCall) Query(query string) *CaseClassificationsSearchCall { + c.urlParams_.Set("query", query) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *CaseClassificationsSearchCall) Fields(s ...googleapi.Field) *CaseClassificationsSearchCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *CaseClassificationsSearchCall) IfNoneMatch(entityTag string) *CaseClassificationsSearchCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *CaseClassificationsSearchCall) Context(ctx context.Context) *CaseClassificationsSearchCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *CaseClassificationsSearchCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *CaseClassificationsSearchCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v2/caseClassifications:search") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "cloudsupport.caseClassifications.search" call. +// Exactly one of *SearchCaseClassificationsResponse or error will be +// non-nil. Any non-2xx status code is an error. Response headers are in +// either *SearchCaseClassificationsResponse.ServerResponse.Header or +// (if a response was returned at all) in +// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check +// whether the returned error was because http.StatusNotModified was +// returned. +func (c *CaseClassificationsSearchCall) Do(opts ...googleapi.CallOption) (*SearchCaseClassificationsResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &SearchCaseClassificationsResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Retrieve valid classifications to be used when creating a support case. The classications are hierarchical, with each classification containing all levels of the hierarchy, separated by `\" \u003e \"`. For example `\"Technical Issue \u003e Compute \u003e Compute Engine\"`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail.", + // "flatPath": "v2/caseClassifications:search", + // "httpMethod": "GET", + // "id": "cloudsupport.caseClassifications.search", + // "parameterOrder": [], + // "parameters": { + // "pageSize": { + // "description": "The maximum number of cases fetched with each request.", + // "format": "int32", + // "location": "query", + // "type": "integer" + // }, + // "pageToken": { + // "description": "A token identifying the page of results to return. If unspecified, the first page is retrieved.", + // "location": "query", + // "type": "string" + // }, + // "query": { + // "description": "An expression written in the Google Cloud filter language. If non-empty, then only cases whose fields match the filter are returned. If empty, then no messages are filtered out.", + // "location": "query", + // "type": "string" + // } + // }, + // "path": "v2/caseClassifications:search", + // "response": { + // "$ref": "SearchCaseClassificationsResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// Pages invokes f for each page of results. +// A non-nil error returned from f will halt the iteration. +// The provided context supersedes any context provided to the Context method. +func (c *CaseClassificationsSearchCall) Pages(ctx context.Context, f func(*SearchCaseClassificationsResponse) error) error { + c.ctx_ = ctx + defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point + for { + x, err := c.Do() + if err != nil { + return err + } + if err := f(x); err != nil { + return err + } + if x.NextPageToken == "" { + return nil + } + c.PageToken(x.NextPageToken) + } +} + +// method id "cloudsupport.cases.close": + +type CasesCloseCall struct { + s *Service + name string + closecaserequest *CloseCaseRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Close: Close the specified case. +// +// - name: The fully qualified name of the case resource to be closed. +func (r *CasesService) Close(name string, closecaserequest *CloseCaseRequest) *CasesCloseCall { + c := &CasesCloseCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + c.closecaserequest = closecaserequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *CasesCloseCall) Fields(s ...googleapi.Field) *CasesCloseCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *CasesCloseCall) Context(ctx context.Context) *CasesCloseCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *CasesCloseCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *CasesCloseCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.closecaserequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+name}:close") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "cloudsupport.cases.close" call. +// Exactly one of *Case or error will be non-nil. Any non-2xx status +// code is an error. Response headers are in either +// *Case.ServerResponse.Header or (if a response was returned at all) in +// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check +// whether the returned error was because http.StatusNotModified was +// returned. +func (c *CasesCloseCall) Do(opts ...googleapi.CallOption) (*Case, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Case{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Close the specified case.", + // "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}:close", + // "httpMethod": "POST", + // "id": "cloudsupport.cases.close", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "Required. The fully qualified name of the case resource to be closed.", + // "location": "path", + // "pattern": "^[^/]+/[^/]+/cases/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v2/{+name}:close", + // "request": { + // "$ref": "CloseCaseRequest" + // }, + // "response": { + // "$ref": "Case" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "cloudsupport.cases.create": + +type CasesCreateCall struct { + s *Service + parent string + case_ *Case + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Create: Create a new case and associate it with the given Google +// Cloud Resource. The case object must have the following fields set: +// `display_name`, `description`, `classification`, and `priority`. +// +// - parent: The name of the Google Cloud Resource under which the case +// should be created. +func (r *CasesService) Create(parent string, case_ *Case) *CasesCreateCall { + c := &CasesCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + c.case_ = case_ + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *CasesCreateCall) Fields(s ...googleapi.Field) *CasesCreateCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *CasesCreateCall) Context(ctx context.Context) *CasesCreateCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *CasesCreateCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *CasesCreateCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.case_) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+parent}/cases") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "cloudsupport.cases.create" call. +// Exactly one of *Case or error will be non-nil. Any non-2xx status +// code is an error. Response headers are in either +// *Case.ServerResponse.Header or (if a response was returned at all) in +// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check +// whether the returned error was because http.StatusNotModified was +// returned. +func (c *CasesCreateCall) Do(opts ...googleapi.CallOption) (*Case, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Case{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Create a new case and associate it with the given Google Cloud Resource. The case object must have the following fields set: `display_name`, `description`, `classification`, and `priority`.", + // "flatPath": "v2/{v2Id}/{v2Id1}/cases", + // "httpMethod": "POST", + // "id": "cloudsupport.cases.create", + // "parameterOrder": [ + // "parent" + // ], + // "parameters": { + // "parent": { + // "description": "Required. The name of the Google Cloud Resource under which the case should be created.", + // "location": "path", + // "pattern": "^[^/]+/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v2/{+parent}/cases", + // "request": { + // "$ref": "Case" + // }, + // "response": { + // "$ref": "Case" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "cloudsupport.cases.escalate": + +type CasesEscalateCall struct { + s *Service + name string + escalatecaserequest *EscalateCaseRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Escalate: Escalate a case. Escalating a case will initiate the Google +// Cloud Support escalation management process. This operation is only +// available to certain Customer Care tiers. Go to +// https://cloud.google.com/support and look for 'Technical support +// escalations' in the feature list to find out which tiers are able to +// perform escalations. +// +// - name: The fully qualified name of the Case resource to be +// escalated. +func (r *CasesService) Escalate(name string, escalatecaserequest *EscalateCaseRequest) *CasesEscalateCall { + c := &CasesEscalateCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + c.escalatecaserequest = escalatecaserequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *CasesEscalateCall) Fields(s ...googleapi.Field) *CasesEscalateCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *CasesEscalateCall) Context(ctx context.Context) *CasesEscalateCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *CasesEscalateCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *CasesEscalateCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.escalatecaserequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+name}:escalate") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "cloudsupport.cases.escalate" call. +// Exactly one of *Case or error will be non-nil. Any non-2xx status +// code is an error. Response headers are in either +// *Case.ServerResponse.Header or (if a response was returned at all) in +// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check +// whether the returned error was because http.StatusNotModified was +// returned. +func (c *CasesEscalateCall) Do(opts ...googleapi.CallOption) (*Case, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Case{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Escalate a case. Escalating a case will initiate the Google Cloud Support escalation management process. This operation is only available to certain Customer Care tiers. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which tiers are able to perform escalations.", + // "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}:escalate", + // "httpMethod": "POST", + // "id": "cloudsupport.cases.escalate", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "Required. The fully qualified name of the Case resource to be escalated.", + // "location": "path", + // "pattern": "^[^/]+/[^/]+/cases/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v2/{+name}:escalate", + // "request": { + // "$ref": "EscalateCaseRequest" + // }, + // "response": { + // "$ref": "Case" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "cloudsupport.cases.get": + +type CasesGetCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// Get: Retrieve the specified case. +// +// - name: The fully qualified name of a case to be retrieved. +func (r *CasesService) Get(name string) *CasesGetCall { + c := &CasesGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *CasesGetCall) Fields(s ...googleapi.Field) *CasesGetCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *CasesGetCall) IfNoneMatch(entityTag string) *CasesGetCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *CasesGetCall) Context(ctx context.Context) *CasesGetCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *CasesGetCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *CasesGetCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "cloudsupport.cases.get" call. +// Exactly one of *Case or error will be non-nil. Any non-2xx status +// code is an error. Response headers are in either +// *Case.ServerResponse.Header or (if a response was returned at all) in +// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check +// whether the returned error was because http.StatusNotModified was +// returned. +func (c *CasesGetCall) Do(opts ...googleapi.CallOption) (*Case, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Case{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Retrieve the specified case.", + // "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}", + // "httpMethod": "GET", + // "id": "cloudsupport.cases.get", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "Required. The fully qualified name of a case to be retrieved.", + // "location": "path", + // "pattern": "^[^/]+/[^/]+/cases/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v2/{+name}", + // "response": { + // "$ref": "Case" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "cloudsupport.cases.list": + +type CasesListCall struct { + s *Service + parent string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// List: Retrieve all cases under the specified parent. Note: Listing +// cases under an Organization returns only the cases directly parented +// by that organization. To retrieve all cases under an organization, +// including cases parented by projects under that organization, use +// `cases.search`. +// +// - parent: The fully qualified name of parent resource to list cases +// under. +func (r *CasesService) List(parent string) *CasesListCall { + c := &CasesListCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + return c +} + +// Filter sets the optional parameter "filter": An expression written in +// filter language. If non-empty, the query returns the cases that match +// the filter. Else, the query doesn't filter the cases. Filter +// expressions use the following fields with the operators equals (`=`) +// and `AND`: - `state`: The accepted values are `OPEN` or `CLOSED`. - +// `priority`: The accepted values are `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. Examples: - `state=CLOSED` - +// `state=OPEN AND creator.email="tester@example.com" - `state=OPEN AND +// (priority=P0 OR priority=P1)` +func (c *CasesListCall) Filter(filter string) *CasesListCall { + c.urlParams_.Set("filter", filter) + return c +} + +// PageSize sets the optional parameter "pageSize": The maximum number +// of cases fetched with each request. Defaults to 10. +func (c *CasesListCall) PageSize(pageSize int64) *CasesListCall { + c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) + return c +} + +// PageToken sets the optional parameter "pageToken": A token +// identifying the page of results to return. If unspecified, the first +// page is retrieved. +func (c *CasesListCall) PageToken(pageToken string) *CasesListCall { + c.urlParams_.Set("pageToken", pageToken) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *CasesListCall) Fields(s ...googleapi.Field) *CasesListCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *CasesListCall) IfNoneMatch(entityTag string) *CasesListCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *CasesListCall) Context(ctx context.Context) *CasesListCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *CasesListCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *CasesListCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+parent}/cases") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "cloudsupport.cases.list" call. +// Exactly one of *ListCasesResponse or error will be non-nil. Any +// non-2xx status code is an error. Response headers are in either +// *ListCasesResponse.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *CasesListCall) Do(opts ...googleapi.CallOption) (*ListCasesResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &ListCasesResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Retrieve all cases under the specified parent. Note: Listing cases under an Organization returns only the cases directly parented by that organization. To retrieve all cases under an organization, including cases parented by projects under that organization, use `cases.search`.", + // "flatPath": "v2/{v2Id}/{v2Id1}/cases", + // "httpMethod": "GET", + // "id": "cloudsupport.cases.list", + // "parameterOrder": [ + // "parent" + // ], + // "parameters": { + // "filter": { + // "description": "An expression written in filter language. If non-empty, the query returns the cases that match the filter. Else, the query doesn't filter the cases. Filter expressions use the following fields with the operators equals (`=`) and `AND`: - `state`: The accepted values are `OPEN` or `CLOSED`. - `priority`: The accepted values are `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. Examples: - `state=CLOSED` - `state=OPEN AND creator.email=\"tester@example.com\"` - `state=OPEN AND (priority=P0 OR priority=P1)`", + // "location": "query", + // "type": "string" + // }, + // "pageSize": { + // "description": "The maximum number of cases fetched with each request. Defaults to 10.", + // "format": "int32", + // "location": "query", + // "type": "integer" + // }, + // "pageToken": { + // "description": "A token identifying the page of results to return. If unspecified, the first page is retrieved.", + // "location": "query", + // "type": "string" + // }, + // "parent": { + // "description": "Required. The fully qualified name of parent resource to list cases under.", + // "location": "path", + // "pattern": "^[^/]+/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v2/{+parent}/cases", + // "response": { + // "$ref": "ListCasesResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// Pages invokes f for each page of results. +// A non-nil error returned from f will halt the iteration. +// The provided context supersedes any context provided to the Context method. +func (c *CasesListCall) Pages(ctx context.Context, f func(*ListCasesResponse) error) error { + c.ctx_ = ctx + defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point + for { + x, err := c.Do() + if err != nil { + return err + } + if err := f(x); err != nil { + return err + } + if x.NextPageToken == "" { + return nil + } + c.PageToken(x.NextPageToken) + } +} + +// method id "cloudsupport.cases.patch": + +type CasesPatchCall struct { + s *Service + name string + case_ *Case + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Patch: Update the specified case. Only a subset of fields can be +// updated. +// +// - name: The resource name for the case. +func (r *CasesService) Patch(name string, case_ *Case) *CasesPatchCall { + c := &CasesPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + c.case_ = case_ + return c +} + +// UpdateMask sets the optional parameter "updateMask": A list of +// attributes of the case object that should be updated as part of this +// request. Supported values are `priority`, `display_name`, and +// `subscriber_email_addresses`. If no fields are specified, all +// supported fields are updated. WARNING: If you do not provide a field +// mask, then you might accidentally clear some fields. For example, if +// you leave the field mask empty and do not provide a value for +// `subscriber_email_addresses`, then `subscriber_email_addresses` is +// updated to empty. +func (c *CasesPatchCall) UpdateMask(updateMask string) *CasesPatchCall { + c.urlParams_.Set("updateMask", updateMask) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *CasesPatchCall) Fields(s ...googleapi.Field) *CasesPatchCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *CasesPatchCall) Context(ctx context.Context) *CasesPatchCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *CasesPatchCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *CasesPatchCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.case_) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("PATCH", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "cloudsupport.cases.patch" call. +// Exactly one of *Case or error will be non-nil. Any non-2xx status +// code is an error. Response headers are in either +// *Case.ServerResponse.Header or (if a response was returned at all) in +// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check +// whether the returned error was because http.StatusNotModified was +// returned. +func (c *CasesPatchCall) Do(opts ...googleapi.CallOption) (*Case, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Case{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Update the specified case. Only a subset of fields can be updated.", + // "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}", + // "httpMethod": "PATCH", + // "id": "cloudsupport.cases.patch", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "The resource name for the case.", + // "location": "path", + // "pattern": "^[^/]+/[^/]+/cases/[^/]+$", + // "required": true, + // "type": "string" + // }, + // "updateMask": { + // "description": "A list of attributes of the case object that should be updated as part of this request. Supported values are `priority`, `display_name`, and `subscriber_email_addresses`. If no fields are specified, all supported fields are updated. WARNING: If you do not provide a field mask, then you might accidentally clear some fields. For example, if you leave the field mask empty and do not provide a value for `subscriber_email_addresses`, then `subscriber_email_addresses` is updated to empty.", + // "format": "google-fieldmask", + // "location": "query", + // "type": "string" + // } + // }, + // "path": "v2/{+name}", + // "request": { + // "$ref": "Case" + // }, + // "response": { + // "$ref": "Case" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "cloudsupport.cases.search": + +type CasesSearchCall struct { + s *Service + parent string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// Search: Search cases using the specified query. +// +// - parent: The fully qualified name of parent resource to search cases +// under. +func (r *CasesService) Search(parent string) *CasesSearchCall { + c := &CasesSearchCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + return c +} + +// PageSize sets the optional parameter "pageSize": The maximum number +// of cases fetched with each request. The default page size is 10. +func (c *CasesSearchCall) PageSize(pageSize int64) *CasesSearchCall { + c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) + return c +} + +// PageToken sets the optional parameter "pageToken": A token +// identifying the page of results to return. If unspecified, the first +// page is retrieved. +func (c *CasesSearchCall) PageToken(pageToken string) *CasesSearchCall { + c.urlParams_.Set("pageToken", pageToken) + return c +} + +// Query sets the optional parameter "query": An expression written in +// filter language. A query uses the following fields with the operators +// equals (`=`) and `AND`: - `organization`: An organization name in the +// form `organizations/`. - `project`: A project name in the form +// `projects/`. - `state`: The accepted values are `OPEN` or `CLOSED`. - +// `priority`: The accepted values are `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. - `billingAccount`: A billing +// account in the form `billingAccounts/` 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" - +// `billing_account="billingAccounts/123456-A0B0C0-CUZ789" - +// `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)` +func (c *CasesSearchCall) Query(query string) *CasesSearchCall { + c.urlParams_.Set("query", query) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *CasesSearchCall) Fields(s ...googleapi.Field) *CasesSearchCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *CasesSearchCall) IfNoneMatch(entityTag string) *CasesSearchCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *CasesSearchCall) Context(ctx context.Context) *CasesSearchCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *CasesSearchCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *CasesSearchCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+parent}/cases:search") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "cloudsupport.cases.search" call. +// Exactly one of *SearchCasesResponse or error will be non-nil. Any +// non-2xx status code is an error. Response headers are in either +// *SearchCasesResponse.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *CasesSearchCall) Do(opts ...googleapi.CallOption) (*SearchCasesResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &SearchCasesResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Search cases using the specified query.", + // "flatPath": "v2/{v2Id}/{v2Id1}/cases:search", + // "httpMethod": "GET", + // "id": "cloudsupport.cases.search", + // "parameterOrder": [ + // "parent" + // ], + // "parameters": { + // "pageSize": { + // "description": "The maximum number of cases fetched with each request. The default page size is 10.", + // "format": "int32", + // "location": "query", + // "type": "integer" + // }, + // "pageToken": { + // "description": "A token identifying the page of results to return. If unspecified, the first page is retrieved.", + // "location": "query", + // "type": "string" + // }, + // "parent": { + // "description": "The fully qualified name of parent resource to search cases under.", + // "location": "path", + // "pattern": "^[^/]+/[^/]+$", + // "required": true, + // "type": "string" + // }, + // "query": { + // "description": "An expression written in filter language. A query uses the following fields with the operators equals (`=`) and `AND`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: The accepted values are `OPEN` or `CLOSED`. - `priority`: The accepted values are `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. - `billingAccount`: A billing account in the form `billingAccounts/` 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\u003e\"2020-01-01T00:00:00-05:00\"`. `update_time` only supports the greater than operator (`\u003e`). Examples: - `organization=\"organizations/123456789\"` - `project=\"projects/my-project-id\"` - `project=\"projects/123456789\"` - `billing_account=\"billingAccounts/123456-A0B0C0-CUZ789\"` - `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" + // } + // }, + // "path": "v2/{+parent}/cases:search", + // "response": { + // "$ref": "SearchCasesResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// Pages invokes f for each page of results. +// A non-nil error returned from f will halt the iteration. +// The provided context supersedes any context provided to the Context method. +func (c *CasesSearchCall) Pages(ctx context.Context, f func(*SearchCasesResponse) error) error { + c.ctx_ = ctx + defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point + for { + x, err := c.Do() + if err != nil { + return err + } + if err := f(x); err != nil { + return err + } + if x.NextPageToken == "" { + return nil + } + c.PageToken(x.NextPageToken) + } +} + +// method id "cloudsupport.cases.attachments.list": + +type CasesAttachmentsListCall struct { + s *Service + parent string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// List: Retrieve all attachments associated with a support case. +// +// - parent: The resource name of Case object for which attachments +// should be listed. +func (r *CasesAttachmentsService) List(parent string) *CasesAttachmentsListCall { + c := &CasesAttachmentsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + return c +} + +// PageSize sets the optional parameter "pageSize": The maximum number +// of attachments fetched with each request. If not provided, the +// default is 10. The maximum page size that will be returned is 100. +func (c *CasesAttachmentsListCall) PageSize(pageSize int64) *CasesAttachmentsListCall { + c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) + return c +} + +// PageToken sets the optional parameter "pageToken": A token +// identifying the page of results to return. If unspecified, the first +// page is retrieved. +func (c *CasesAttachmentsListCall) PageToken(pageToken string) *CasesAttachmentsListCall { + c.urlParams_.Set("pageToken", pageToken) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *CasesAttachmentsListCall) Fields(s ...googleapi.Field) *CasesAttachmentsListCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *CasesAttachmentsListCall) IfNoneMatch(entityTag string) *CasesAttachmentsListCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *CasesAttachmentsListCall) Context(ctx context.Context) *CasesAttachmentsListCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *CasesAttachmentsListCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *CasesAttachmentsListCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+parent}/attachments") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "cloudsupport.cases.attachments.list" call. +// Exactly one of *ListAttachmentsResponse or error will be non-nil. Any +// non-2xx status code is an error. Response headers are in either +// *ListAttachmentsResponse.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *CasesAttachmentsListCall) Do(opts ...googleapi.CallOption) (*ListAttachmentsResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &ListAttachmentsResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Retrieve all attachments associated with a support case.", + // "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}/attachments", + // "httpMethod": "GET", + // "id": "cloudsupport.cases.attachments.list", + // "parameterOrder": [ + // "parent" + // ], + // "parameters": { + // "pageSize": { + // "description": "The maximum number of attachments fetched with each request. If not provided, the default is 10. The maximum page size that will be returned is 100.", + // "format": "int32", + // "location": "query", + // "type": "integer" + // }, + // "pageToken": { + // "description": "A token identifying the page of results to return. If unspecified, the first page is retrieved.", + // "location": "query", + // "type": "string" + // }, + // "parent": { + // "description": "Required. The resource name of Case object for which attachments should be listed.", + // "location": "path", + // "pattern": "^[^/]+/[^/]+/cases/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v2/{+parent}/attachments", + // "response": { + // "$ref": "ListAttachmentsResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// Pages invokes f for each page of results. +// A non-nil error returned from f will halt the iteration. +// The provided context supersedes any context provided to the Context method. +func (c *CasesAttachmentsListCall) Pages(ctx context.Context, f func(*ListAttachmentsResponse) error) error { + c.ctx_ = ctx + defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point + for { + x, err := c.Do() + if err != nil { + return err + } + if err := f(x); err != nil { + return err + } + if x.NextPageToken == "" { + return nil + } + c.PageToken(x.NextPageToken) + } +} + +// method id "cloudsupport.cases.comments.create": + +type CasesCommentsCreateCall struct { + s *Service + parent string + comment *Comment + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Create: Add a new comment to the specified Case. The comment object +// must have the following fields set: body. +// +// - parent: The resource name of Case to which this comment should be +// added. +func (r *CasesCommentsService) Create(parent string, comment *Comment) *CasesCommentsCreateCall { + c := &CasesCommentsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + c.comment = comment + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *CasesCommentsCreateCall) Fields(s ...googleapi.Field) *CasesCommentsCreateCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *CasesCommentsCreateCall) Context(ctx context.Context) *CasesCommentsCreateCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *CasesCommentsCreateCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *CasesCommentsCreateCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.comment) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+parent}/comments") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "cloudsupport.cases.comments.create" call. +// Exactly one of *Comment or error will be non-nil. Any non-2xx status +// code is an error. Response headers are in either +// *Comment.ServerResponse.Header or (if a response was returned at all) +// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to +// check whether the returned error was because http.StatusNotModified +// was returned. +func (c *CasesCommentsCreateCall) Do(opts ...googleapi.CallOption) (*Comment, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Comment{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Add a new comment to the specified Case. The comment object must have the following fields set: body.", + // "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}/comments", + // "httpMethod": "POST", + // "id": "cloudsupport.cases.comments.create", + // "parameterOrder": [ + // "parent" + // ], + // "parameters": { + // "parent": { + // "description": "Required. The resource name of Case to which this comment should be added.", + // "location": "path", + // "pattern": "^[^/]+/[^/]+/cases/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v2/{+parent}/comments", + // "request": { + // "$ref": "Comment" + // }, + // "response": { + // "$ref": "Comment" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "cloudsupport.cases.comments.list": + +type CasesCommentsListCall struct { + s *Service + parent string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// List: Retrieve all Comments associated with the Case object. +// +// - parent: The resource name of Case object for which comments should +// be listed. +func (r *CasesCommentsService) List(parent string) *CasesCommentsListCall { + c := &CasesCommentsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + return c +} + +// PageSize sets the optional parameter "pageSize": The maximum number +// of comments fetched with each request. Defaults to 10. +func (c *CasesCommentsListCall) PageSize(pageSize int64) *CasesCommentsListCall { + c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) + return c +} + +// PageToken sets the optional parameter "pageToken": A token +// identifying the page of results to return. If unspecified, the first +// page is retrieved. +func (c *CasesCommentsListCall) PageToken(pageToken string) *CasesCommentsListCall { + c.urlParams_.Set("pageToken", pageToken) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *CasesCommentsListCall) Fields(s ...googleapi.Field) *CasesCommentsListCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *CasesCommentsListCall) IfNoneMatch(entityTag string) *CasesCommentsListCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *CasesCommentsListCall) Context(ctx context.Context) *CasesCommentsListCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *CasesCommentsListCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *CasesCommentsListCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+parent}/comments") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "cloudsupport.cases.comments.list" call. +// Exactly one of *ListCommentsResponse or error will be non-nil. Any +// non-2xx status code is an error. Response headers are in either +// *ListCommentsResponse.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *CasesCommentsListCall) Do(opts ...googleapi.CallOption) (*ListCommentsResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &ListCommentsResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Retrieve all Comments associated with the Case object.", + // "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}/comments", + // "httpMethod": "GET", + // "id": "cloudsupport.cases.comments.list", + // "parameterOrder": [ + // "parent" + // ], + // "parameters": { + // "pageSize": { + // "description": "The maximum number of comments fetched with each request. Defaults to 10.", + // "format": "int32", + // "location": "query", + // "type": "integer" + // }, + // "pageToken": { + // "description": "A token identifying the page of results to return. If unspecified, the first page is retrieved.", + // "location": "query", + // "type": "string" + // }, + // "parent": { + // "description": "Required. The resource name of Case object for which comments should be listed.", + // "location": "path", + // "pattern": "^[^/]+/[^/]+/cases/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v2/{+parent}/comments", + // "response": { + // "$ref": "ListCommentsResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// Pages invokes f for each page of results. +// A non-nil error returned from f will halt the iteration. +// The provided context supersedes any context provided to the Context method. +func (c *CasesCommentsListCall) Pages(ctx context.Context, f func(*ListCommentsResponse) error) error { + c.ctx_ = ctx + defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point + for { + x, err := c.Do() + if err != nil { + return err + } + if err := f(x); err != nil { + return err + } + if x.NextPageToken == "" { + return nil + } + c.PageToken(x.NextPageToken) + } +} + +// method id "cloudsupport.media.download": + +type MediaDownloadCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// Download: Download a file attachment on a case. Note: HTTP requests +// must append "?alt=media" to the URL. +// +// - name: The resource name of the attachment to be downloaded. +func (r *MediaService) Download(name string) *MediaDownloadCall { + c := &MediaDownloadCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *MediaDownloadCall) Fields(s ...googleapi.Field) *MediaDownloadCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *MediaDownloadCall) IfNoneMatch(entityTag string) *MediaDownloadCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do and Download +// methods. Any pending HTTP request will be aborted if the provided +// context is canceled. +func (c *MediaDownloadCall) Context(ctx context.Context) *MediaDownloadCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *MediaDownloadCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *MediaDownloadCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+name}:download") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Download fetches the API endpoint's "media" value, instead of the normal +// API response value. If the returned error is nil, the Response is guaranteed to +// have a 2xx status code. Callers must close the Response.Body as usual. +func (c *MediaDownloadCall) Download(opts ...googleapi.CallOption) (*http.Response, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("media") + if err != nil { + return nil, err + } + if err := googleapi.CheckResponse(res); err != nil { + res.Body.Close() + return nil, gensupport.WrapError(err) + } + return res, nil +} + +// Do executes the "cloudsupport.media.download" call. +// Exactly one of *Media or error will be non-nil. Any non-2xx status +// code is an error. Response headers are in either +// *Media.ServerResponse.Header or (if a response was returned at all) +// in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to +// check whether the returned error was because http.StatusNotModified +// was returned. +func (c *MediaDownloadCall) Do(opts ...googleapi.CallOption) (*Media, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Media{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Download a file attachment on a case. Note: HTTP requests must append \"?alt=media\" to the URL.", + // "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}/attachments/{attachmentsId}:download", + // "httpMethod": "GET", + // "id": "cloudsupport.media.download", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "The resource name of the attachment to be downloaded.", + // "location": "path", + // "pattern": "^[^/]+/[^/]+/cases/[^/]+/attachments/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v2/{+name}:download", + // "response": { + // "$ref": "Media" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ], + // "supportsMediaDownload": true, + // "useMediaDownloadService": true + // } + +} + +// method id "cloudsupport.media.upload": + +type MediaUploadCall struct { + s *Service + parent string + createattachmentrequest *CreateAttachmentRequest + urlParams_ gensupport.URLParams + mediaInfo_ *gensupport.MediaInfo + ctx_ context.Context + header_ http.Header +} + +// Upload: Create a file attachment on a case or Cloud resource. The +// attachment object must have the following fields set: filename. +// +// - parent: The resource name of the case (or case parent) to which the +// attachment should be attached. +func (r *MediaService) Upload(parent string, createattachmentrequest *CreateAttachmentRequest) *MediaUploadCall { + c := &MediaUploadCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + c.createattachmentrequest = createattachmentrequest + return c +} + +// Media specifies the media to upload in one or more chunks. The chunk +// size may be controlled by supplying a MediaOption generated by +// googleapi.ChunkSize. The chunk size defaults to +// googleapi.DefaultUploadChunkSize.The Content-Type header used in the +// upload request will be determined by sniffing the contents of r, +// unless a MediaOption generated by googleapi.ContentType is +// supplied. +// At most one of Media and ResumableMedia may be set. +func (c *MediaUploadCall) Media(r io.Reader, options ...googleapi.MediaOption) *MediaUploadCall { + c.mediaInfo_ = gensupport.NewInfoFromMedia(r, options) + return c +} + +// ResumableMedia specifies the media to upload in chunks and can be +// canceled with ctx. +// +// Deprecated: use Media instead. +// +// At most one of Media and ResumableMedia may be set. mediaType +// identifies the MIME media type of the upload, such as "image/png". If +// mediaType is "", it will be auto-detected. The provided ctx will +// supersede any context previously provided to the Context method. +func (c *MediaUploadCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *MediaUploadCall { + c.ctx_ = ctx + c.mediaInfo_ = gensupport.NewInfoFromResumableMedia(r, size, mediaType) + return c +} + +// ProgressUpdater provides a callback function that will be called +// after every chunk. It should be a low-latency function in order to +// not slow down the upload operation. This should only be called when +// using ResumableMedia (as opposed to Media). +func (c *MediaUploadCall) ProgressUpdater(pu googleapi.ProgressUpdater) *MediaUploadCall { + c.mediaInfo_.SetProgressUpdater(pu) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *MediaUploadCall) Fields(s ...googleapi.Field) *MediaUploadCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +// This context will supersede any context previously provided to the +// ResumableMedia method. +func (c *MediaUploadCall) Context(ctx context.Context) *MediaUploadCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *MediaUploadCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *MediaUploadCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.createattachmentrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v2/{+parent}/attachments") + if c.mediaInfo_ != nil { + urls = googleapi.ResolveRelative(c.s.BasePath, "/upload/v2/{+parent}/attachments") + c.urlParams_.Set("uploadType", c.mediaInfo_.UploadType()) + } + if body == nil { + body = new(bytes.Buffer) + reqHeaders.Set("Content-Type", "application/json") + } + body, getBody, cleanup := c.mediaInfo_.UploadRequest(reqHeaders, body) + defer cleanup() + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + req.GetBody = getBody + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "cloudsupport.media.upload" call. +// Exactly one of *Attachment or error will be non-nil. Any non-2xx +// status code is an error. Response headers are in either +// *Attachment.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified +// to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *MediaUploadCall) Do(opts ...googleapi.CallOption) (*Attachment, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + rx := c.mediaInfo_.ResumableUpload(res.Header.Get("Location")) + if rx != nil { + rx.Client = c.s.client + rx.UserAgent = c.s.userAgent() + ctx := c.ctx_ + if ctx == nil { + ctx = context.TODO() + } + res, err = rx.Upload(ctx) + if err != nil { + return nil, err + } + defer res.Body.Close() + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + } + ret := &Attachment{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Create a file attachment on a case or Cloud resource. The attachment object must have the following fields set: filename.", + // "flatPath": "v2/{v2Id}/{v2Id1}/cases/{casesId}/attachments", + // "httpMethod": "POST", + // "id": "cloudsupport.media.upload", + // "mediaUpload": { + // "accept": [ + // "*/*" + // ], + // "protocols": { + // "simple": { + // "multipart": true, + // "path": "/upload/v2/{+parent}/attachments" + // } + // } + // }, + // "parameterOrder": [ + // "parent" + // ], + // "parameters": { + // "parent": { + // "description": "Required. The resource name of the case (or case parent) to which the attachment should be attached.", + // "location": "path", + // "pattern": "^[^/]+/[^/]+/cases/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v2/{+parent}/attachments", + // "request": { + // "$ref": "CreateAttachmentRequest" + // }, + // "response": { + // "$ref": "Attachment" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ], + // "supportsMediaUpload": true + // } + +} diff --git a/cloudsupport/v2beta/cloudsupport-api.json b/cloudsupport/v2beta/cloudsupport-api.json index 83aa95955af..d008b150cd3 100644 --- a/cloudsupport/v2beta/cloudsupport-api.json +++ b/cloudsupport/v2beta/cloudsupport-api.json @@ -345,6 +345,11 @@ "location": "query", "type": "string" }, + "parent": { + "description": "The fully qualified name of parent resource to search cases under.", + "location": "query", + "type": "string" + }, "query": { "description": "An expression written in filter language. A query uses the following fields with the operators equals (`=`) and `AND`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: The accepted values are `OPEN` or `CLOSED`. - `priority`: The accepted values are `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. - `billingAccount`: A billing account in the form `billingAccounts/` 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\u003e\"2020-01-01T00:00:00-05:00\"`. `update_time` only supports the greater than operator (`\u003e`). Examples: - `organization=\"organizations/123456789\"` - `project=\"projects/my-project-id\"` - `project=\"projects/123456789\"` - `billing_account=\"billingAccounts/123456-A0B0C0-CUZ789\"` - `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", @@ -543,7 +548,7 @@ } } }, - "revision": "20230614", + "revision": "20230626", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { diff --git a/cloudsupport/v2beta/cloudsupport-gen.go b/cloudsupport/v2beta/cloudsupport-gen.go index 478e9fd9581..3215d735c31 100644 --- a/cloudsupport/v2beta/cloudsupport-gen.go +++ b/cloudsupport/v2beta/cloudsupport-gen.go @@ -2615,6 +2615,13 @@ func (c *CasesSearchCall) PageToken(pageToken string) *CasesSearchCall { return c } +// Parent sets the optional parameter "parent": The fully qualified name +// of parent resource to search cases under. +func (c *CasesSearchCall) Parent(parent string) *CasesSearchCall { + c.urlParams_.Set("parent", parent) + return c +} + // Query sets the optional parameter "query": An expression written in // filter language. A query uses the following fields with the operators // equals (`=`) and `AND`: - `organization`: An organization name in the @@ -2757,6 +2764,11 @@ func (c *CasesSearchCall) Do(opts ...googleapi.CallOption) (*SearchCasesResponse // "location": "query", // "type": "string" // }, + // "parent": { + // "description": "The fully qualified name of parent resource to search cases under.", + // "location": "query", + // "type": "string" + // }, // "query": { // "description": "An expression written in filter language. A query uses the following fields with the operators equals (`=`) and `AND`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: The accepted values are `OPEN` or `CLOSED`. - `priority`: The accepted values are `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. - `billingAccount`: A billing account in the form `billingAccounts/` 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\u003e\"2020-01-01T00:00:00-05:00\"`. `update_time` only supports the greater than operator (`\u003e`). Examples: - `organization=\"organizations/123456789\"` - `project=\"projects/my-project-id\"` - `project=\"projects/123456789\"` - `billing_account=\"billingAccounts/123456-A0B0C0-CUZ789\"` - `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", diff --git a/contactcenteraiplatform/v1alpha1/contactcenteraiplatform-api.json b/contactcenteraiplatform/v1alpha1/contactcenteraiplatform-api.json index 9acb59fa745..fc9868c3b91 100644 --- a/contactcenteraiplatform/v1alpha1/contactcenteraiplatform-api.json +++ b/contactcenteraiplatform/v1alpha1/contactcenteraiplatform-api.json @@ -571,7 +571,7 @@ } } }, - "revision": "20230615", + "revision": "20230621", "rootUrl": "https://contactcenteraiplatform.googleapis.com/", "schemas": { "AdminUser": { @@ -621,7 +621,7 @@ "type": "object" }, "ContactCenter": { - "description": "Message describing ContactCenter object Next ID: 14", + "description": "Message describing ContactCenter object Next ID: 15", "id": "ContactCenter", "properties": { "adminUser": { @@ -650,6 +650,10 @@ "$ref": "InstanceConfig", "description": "The configuration of this instance, it is currently immutable once created." }, + "kmsKey": { + "description": "Immutable. The KMS key name to encrypt the user input (`ContactCenter`).", + "type": "string" + }, "labels": { "additionalProperties": { "type": "string" @@ -711,11 +715,13 @@ "id": "ContactCenterQuota", "properties": { "contactCenterCountLimit": { + "deprecated": true, "description": "Deprecated: Use the Quota fields instead. Reflects the count limit of contact centers on a billing account.", "format": "int32", "type": "integer" }, "contactCenterCountSum": { + "deprecated": true, "description": "Deprecated: Use the Quota fields instead. Reflects the count sum of contact centers on a billing account.", "format": "int32", "type": "integer" @@ -1047,6 +1053,7 @@ "type": "string" }, "userEmail": { + "deprecated": true, "description": "Email address of the first admin users.", "type": "string" } diff --git a/contactcenteraiplatform/v1alpha1/contactcenteraiplatform-gen.go b/contactcenteraiplatform/v1alpha1/contactcenteraiplatform-gen.go index 54db85bc724..15d4866e0d2 100644 --- a/contactcenteraiplatform/v1alpha1/contactcenteraiplatform-gen.go +++ b/contactcenteraiplatform/v1alpha1/contactcenteraiplatform-gen.go @@ -284,7 +284,7 @@ func (s *BasicAuthConfig) MarshalJSON() ([]byte, error) { type CancelOperationRequest struct { } -// ContactCenter: Message describing ContactCenter object Next ID: 14 +// ContactCenter: Message describing ContactCenter object Next ID: 15 type ContactCenter struct { // AdminUser: Optional. Info about the first admin user, such as given // name and family name. @@ -309,6 +309,10 @@ type ContactCenter struct { // immutable once created. InstanceConfig *InstanceConfig `json:"instanceConfig,omitempty"` + // KmsKey: Immutable. The KMS key name to encrypt the user input + // (`ContactCenter`). + KmsKey string `json:"kmsKey,omitempty"` + // Labels: Labels as key value pairs Labels map[string]string `json:"labels,omitempty"` diff --git a/contactcenterinsights/v1/contactcenterinsights-api.json b/contactcenterinsights/v1/contactcenterinsights-api.json index 69e2d405a87..d189338bccf 100644 --- a/contactcenterinsights/v1/contactcenterinsights-api.json +++ b/contactcenterinsights/v1/contactcenterinsights-api.json @@ -1384,7 +1384,7 @@ } } }, - "revision": "20230621", + "revision": "20230626", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -2921,6 +2921,24 @@ "readOnly": true, "type": "string" }, + "languageCode": { + "description": "Language of the model.", + "type": "string" + }, + "modelType": { + "description": "Type of the model.", + "enum": [ + "MODEL_TYPE_UNSPECIFIED", + "TYPE_V1", + "TYPE_V2" + ], + "enumDescriptions": [ + "Unspecified model type.", + "Type V1.", + "Type V2." + ], + "type": "string" + }, "name": { "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" @@ -5035,6 +5053,24 @@ "readOnly": true, "type": "string" }, + "languageCode": { + "description": "Language of the model.", + "type": "string" + }, + "modelType": { + "description": "Type of the model.", + "enum": [ + "MODEL_TYPE_UNSPECIFIED", + "TYPE_V1", + "TYPE_V2" + ], + "enumDescriptions": [ + "Unspecified model type.", + "Type V1.", + "Type V2." + ], + "type": "string" + }, "name": { "description": "Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model}", "type": "string" diff --git a/contactcenterinsights/v1/contactcenterinsights-gen.go b/contactcenterinsights/v1/contactcenterinsights-gen.go index 5505e32e12d..3b40bbadbbd 100644 --- a/contactcenterinsights/v1/contactcenterinsights-gen.go +++ b/contactcenterinsights/v1/contactcenterinsights-gen.go @@ -2765,6 +2765,17 @@ type GoogleCloudContactcenterinsightsV1IssueModel struct { // IssueCount: Output only. Number of issues in this issue model. IssueCount int64 `json:"issueCount,omitempty,string"` + // LanguageCode: Language of the model. + LanguageCode string `json:"languageCode,omitempty"` + + // ModelType: Type of the model. + // + // Possible values: + // "MODEL_TYPE_UNSPECIFIED" - Unspecified model type. + // "TYPE_V1" - Type V1. + // "TYPE_V2" - Type V2. + ModelType string `json:"modelType,omitempty"` + // Name: Immutable. The resource name of the issue model. Format: // projects/{project}/locations/{location}/issueModels/{issue_model} Name string `json:"name,omitempty"` @@ -6283,6 +6294,17 @@ type GoogleCloudContactcenterinsightsV1alpha1IssueModel struct { // IssueCount: Output only. Number of issues in this issue model. IssueCount int64 `json:"issueCount,omitempty,string"` + // LanguageCode: Language of the model. + LanguageCode string `json:"languageCode,omitempty"` + + // ModelType: Type of the model. + // + // Possible values: + // "MODEL_TYPE_UNSPECIFIED" - Unspecified model type. + // "TYPE_V1" - Type V1. + // "TYPE_V2" - Type V2. + ModelType string `json:"modelType,omitempty"` + // Name: Immutable. The resource name of the issue model. Format: // projects/{project}/locations/{location}/issueModels/{issue_model} Name string `json:"name,omitempty"` diff --git a/container/v1/container-api.json b/container/v1/container-api.json index 83716edd616..2d9de1ea28f 100644 --- a/container/v1/container-api.json +++ b/container/v1/container-api.json @@ -2540,7 +2540,7 @@ } } }, - "revision": "20230522", + "revision": "20230614", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3351,6 +3351,25 @@ }, "type": "object" }, + "ClusterNetworkPerformanceConfig": { + "description": "Configuration of network bandwidth tiers", + "id": "ClusterNetworkPerformanceConfig", + "properties": { + "totalEgressBandwidthTier": { + "description": "Specifies the total network bandwidth tier for NodePools in the cluster.", + "enum": [ + "TIER_UNSPECIFIED", + "TIER_1" + ], + "enumDescriptions": [ + "Default value", + "Higher bandwidth, actual values based on VM size." + ], + "type": "string" + } + }, + "type": "object" + }, "ClusterUpdate": { "description": "ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided.", "id": "ClusterUpdate", @@ -3484,6 +3503,10 @@ "description": "The monitoring service the cluster should use to write metrics. Currently available options: * \"monitoring.googleapis.com/kubernetes\" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.", "type": "string" }, + "desiredNetworkPerformanceConfig": { + "$ref": "ClusterNetworkPerformanceConfig", + "description": "The desired network performance config." + }, "desiredNodePoolAutoConfigNetworkTags": { "$ref": "NetworkTags", "description": "The desired network tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters." @@ -3717,12 +3740,14 @@ "enum": [ "PROVIDER_UNSPECIFIED", "PLATFORM_DEFAULT", - "CLOUD_DNS" + "CLOUD_DNS", + "KUBE_DNS" ], "enumDescriptions": [ "Default value", "Use GKE default DNS provider(kube-dns) for DNS resolution.", - "Use CloudDNS for DNS resolution." + "Use CloudDNS for DNS resolution.", + "Use KubeDNS for DNS resolution" ], "type": "string" }, @@ -4764,6 +4789,10 @@ "description": "Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", "type": "string" }, + "networkPerformanceConfig": { + "$ref": "ClusterNetworkPerformanceConfig", + "description": "Network bandwidth tier configuration." + }, "privateIpv6GoogleAccess": { "description": "The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4)", "enum": [ diff --git a/container/v1/container-gen.go b/container/v1/container-gen.go index 27233a714f4..8f088024d6b 100644 --- a/container/v1/container-gen.go +++ b/container/v1/container-gen.go @@ -1531,6 +1531,42 @@ func (s *ClusterAutoscaling) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// ClusterNetworkPerformanceConfig: Configuration of network bandwidth +// tiers +type ClusterNetworkPerformanceConfig struct { + // TotalEgressBandwidthTier: Specifies the total network bandwidth tier + // for NodePools in the cluster. + // + // Possible values: + // "TIER_UNSPECIFIED" - Default value + // "TIER_1" - Higher bandwidth, actual values based on VM size. + TotalEgressBandwidthTier string `json:"totalEgressBandwidthTier,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "TotalEgressBandwidthTier") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "TotalEgressBandwidthTier") + // to include in API requests with the JSON null value. By default, + // fields with empty values are omitted from API requests. However, any + // field with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *ClusterNetworkPerformanceConfig) MarshalJSON() ([]byte, error) { + type NoMethod ClusterNetworkPerformanceConfig + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // ClusterUpdate: ClusterUpdate describes an update to the cluster. // Exactly one update can be applied to a cluster with each request, so // at most one field can be provided. @@ -1677,6 +1713,10 @@ type ClusterUpdate struct { // versions. DesiredMonitoringService string `json:"desiredMonitoringService,omitempty"` + // DesiredNetworkPerformanceConfig: The desired network performance + // config. + DesiredNetworkPerformanceConfig *ClusterNetworkPerformanceConfig `json:"desiredNetworkPerformanceConfig,omitempty"` + // DesiredNodePoolAutoConfigNetworkTags: The desired network tags that // apply to all auto-provisioned node pools in autopilot clusters and // node auto-provisioning enabled clusters. @@ -2083,6 +2123,7 @@ type DNSConfig struct { // "PLATFORM_DEFAULT" - Use GKE default DNS provider(kube-dns) for DNS // resolution. // "CLOUD_DNS" - Use CloudDNS for DNS resolution. + // "KUBE_DNS" - Use KubeDNS for DNS resolution ClusterDns string `json:"clusterDns,omitempty"` // ClusterDnsDomain: cluster_dns_domain is the suffix used for all @@ -4059,6 +4100,9 @@ type NetworkConfig struct { // projects/my-project/global/networks/my-network Network string `json:"network,omitempty"` + // NetworkPerformanceConfig: Network bandwidth tier configuration. + NetworkPerformanceConfig *ClusterNetworkPerformanceConfig `json:"networkPerformanceConfig,omitempty"` + // PrivateIpv6GoogleAccess: The desired state of IPv6 connectivity to // Google Services. By default, no private IPv6 access to or from Google // Services (all access will be via IPv4) diff --git a/contentwarehouse/v1/contentwarehouse-api.json b/contentwarehouse/v1/contentwarehouse-api.json index c4bbff9e74c..168da27f592 100644 --- a/contentwarehouse/v1/contentwarehouse-api.json +++ b/contentwarehouse/v1/contentwarehouse-api.json @@ -1128,7 +1128,7 @@ } } }, - "revision": "20230620", + "revision": "20230627", "rootUrl": "https://contentwarehouse.googleapis.com/", "schemas": { "AbuseiamAbuseType": { @@ -3656,7 +3656,8 @@ "ACCESSIBILITY_TRACKER_AFFINITY", "PLX_DATASOURCE_AFFINITY", "DUCKIEWEB_AFFINITY", - "MEET_CALLING_AFFINITY" + "MEET_CALLING_AFFINITY", + "MATTERSPACE_AFFINITY" ], "enumDescriptions": [ "", @@ -3912,6 +3913,7 @@ "", "", "", + "", "" ], "type": "string" @@ -4027,6 +4029,18 @@ "description": "Store the app unique id endpoint. This will be passed over to app to fulfill the action. For example, app_unique_id for Whatsapp will be \"11234567890@s.whatsapp.net\"", "type": "string" }, + "contactInfoSource": { + "description": "Where this contact info was retrieved from. Note: only added for Assistant usage, and will not be populated by PAPI. This is due to the coupling between Assistant Proto, and PAPI proto. (//depot/google3/quality/qrewrite/servlets/proto/focus_name.proto)", + "enum": [ + "SOURCE_UNKNOWN", + "APP_SEARCH" + ], + "enumDescriptions": [ + "", + "The contact info came from AppSearch." + ], + "type": "string" + }, "displayAppUniqueId": { "description": "Store third party endpoint that is displayed to users. For example, display_app_unique_id for Whatsapp will be \"Message +11234567890\".", "type": "string" @@ -4393,10 +4407,6 @@ "description": "Contact-level people-prompts settings and contact-level connection reminders. Part of go/people-prompts.", "id": "AppsPeopleOzExternalMergedpeopleapiConnectionReminder", "properties": { - "contactPromptSettings": { - "$ref": "SocialGraphApiProtoContactPromptSettings", - "description": "Contains the Contact level settings that will affect all reminders." - }, "metadata": { "$ref": "AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata" }, @@ -11380,13 +11390,139 @@ "type": "object" }, "AssistantApiCoreTypesGovernedSurfaceIdentity": { - "description": "The set of information that helps the server identify the surface. This replaces the User-Agent string within the Assistant Server. Note: The SurfaceIdentity proto should only be used to derive the capabilities of a surface. It should not be accessed outside of the CapabilityBuilder or CapabilityChecker. NEXT ID: 5 LINT.IfChange", + "description": "The set of information that helps the server identify the surface. This replaces the User-Agent string within the Assistant Server. Note: The SurfaceIdentity proto should only be used to derive the capabilities of a surface. It should not be accessed outside of the CapabilityBuilder or CapabilityChecker. NEXT ID: 6 LINT.IfChange", "id": "AssistantApiCoreTypesGovernedSurfaceIdentity", "properties": { "deviceId": { "$ref": "AssistantApiCoreTypesDeviceId", "description": "The identifier of the device." }, + "legacySurfaceType": { + "description": "DEPRECATED: The legacy device's surface type enum. NOTE: Prefer using the ontological `surface_type` field above. If you need to access the legacy surface type, please file a bug and add it in your code to migrate to ontological surface type.", + "enum": [ + "UNKNOWN", + "ANDROID_ALLO", + "ANDROID_AUTO", + "ANDROID_THINGS_CUBE", + "ANDROID_THINGS_JASPER", + "ANDROID_TV", + "ANDROID_TV_KIDS", + "ANDROID_WEAR", + "AR_GLASSES", + "ASSISTANT_SDK", + "AUDIOWEAR", + "BUBBLE_CHARACTERS_IOS", + "CAPABILITY_BASED_SURFACE", + "CHROMECAST_ASSISTANT", + "CHROMECAST_MANHATTAN", + "CHROMECAST_SEARCH", + "CLOUD_DEVICE", + "COMPANION_SCREEN", + "DYNAMITE_WEB", + "ENSEMBLE", + "EYESFREE_AGSA", + "EYESFREE_GMM", + "GBOARD", + "GLASS", + "GOOGLE_HOME", + "HANGOUTS_CHATBOT", + "IOS_ALLO", + "IOS_GSA", + "IOS_WEAR", + "LIBASSISTANT", + "LINE_CHATBOT", + "MULTIMODAL_AGSA", + "NON_ASSISTANT_SURFACE", + "OPA_AGSA", + "OPA_AGSA_CHROME_OS", + "OPA_ANDROID_AUTO", + "OPA_ANDROID_LITE", + "OPA_ANDROID_SCREENLESS", + "OPA_ANDROID_SMART_DISPLAY", + "OPA_ANDROID_TABLET", + "OPA_CROS", + "OPA_GACS", + "OPA_IOS", + "OPA_IOS_SCREENLESS", + "OPA_KAIOS", + "OPA_MOBILE_WEB", + "RTOS_PHONE", + "SMS_CHATBOT", + "TELEGRAM_CHATBOT", + "TELEPHONE_ASSISTANT", + "VERILY_ONDUO", + "YOUTUBE_APP", + "AGSA_BISTO_FOR_EVAL", + "COGSWORTH_FOR_EVAL", + "LOCKHART_MIC_FOR_EVAL", + "OPA_ANDROID_AUTO_EMBEDDED_FAKE", + "SPARK", + "WALLE", + "UNIT_TESTING" + ], + "enumDescriptions": [ + "", + "", + "Deprecated (never used). Use OPA_ANDROID_AUTO instead.", + "Assistant on small screen stationary device.", + "", + "", + "", + "", + "Assistant on AR Glasses with both visual and audio experiences. Ask ar-assistant@ for details.", + "For Assistant SDK gRPC client.", + "", + "go/assistant-lamda-overview-characters", + "Surface for capability based testing.", + "For chrome cast assistant web app.", + "For chrome cast with assistant + screen (e.g., Google Nest Hub).", + "", + "Virtual device for event-based triggering, e.g. executing time", + "scheduled routines: go/routine-cloud-ex For Quartz.", + "", + "", + "Deprecated. Please use OPA_ANDROID_SCREENLESS.", + "", + "For Gboard app", + "", + "", + "", + "", + "", + "", + "For standalone libassistant devices.", + "LINE 3P messaging app", + "Deprecated.", + "Surfaces that do not speak to the Assistant, i.e. web HQ", + "Assistant on Android phones accessed through the Google App (velvet). This represents neither all of the assistant on android phones (ANDROID_ALLO, VERILY_ONDUO, etc.) nor all of the assistant built on top of AGSA (ANDROID_WEAR, OPA_ANDROID_SCREENLESS, OPA_AGSA_CHROME_OS, etc.).", + "Deprecated. Please use OPA_CROS.", + "", + "This is OPA on Android Go (not part of AGSA)", + "Assistant on Nexus with screen off/locked. Use go/bisto device to trigger.", + "Assistant on Titan hub mode (go/titan-hubmode-surface). This is OPA Android first party Smart Display devices. The UI experience is built on Opal (Gallium and Flutter) and native Android.", + "Assistant on Android tablet", + "Assistant on native Chrome OS (go/croissant).", + "For assistant on GACS devices (go/gacs-dd). Google Assistant Conversation Service (GACS) defines intents the device accepts. This surface serves the intents in the assistant response.", + "", + "Assistant on iOS with screen off/locked. Use go/bisto device to trigger.", + "Assistant on KaiOS. go/kaiosama", + "Assistant on Mobile Web. go/opa-spidey", + "Assistant on low-cost RTOS phones (go/conceRTOS).", + "", + "Telegram 3P messaging app", + "Assistant on a phone call (go/telephone).", + "", + "A Youtube app.", + "Eval-only surfaces. These surfaces are not real surfaces. They are only used in intermediate steps of eval query and request generation: 1. Eval samplers (OPA query sampler and Cannery sampler) checks logs and temporarily assigns these surface types to the logs, to put Bisto, Lockhart Mic, ... queries in the correct query pools. 2. Request builders uses these surface types to determine how TaskRequest for Bisto, Lockhart Mic, ... should be built, like whether some user user agent should be used, whether some entry source should be set. The surface types in the generated TaskRequest is still the production surface types, like OPA_ANDROID_SCREENLESS or OPA_AGSA. Temp surface for Bisto Android eval. Will be merged with OPA_ANDROID_SCREENLESS in the future.", + "", + "", + "OPA_ANDROID_AUTO has another sub-surface (embedded) that differs in the reported capabilities, client-ops, flags but uses the same surface_type string of OPA_ANDROID_AUTO. This fake surface would allow running turing2 tests and evals for this embedded surface. Deprecated as of Feb 2019. Please use \"OPA_ANDROID_AUTO_EMBEDDED\" client type for tests and eval. See go/client-onboarding for more details. https://cs.corp.google.com/piper///depot/google3/assistant/assistant_server/tools/util/consts.h?l=32\u0026rcl=247481455", + "Unlaunched new surface prototype, ask spark-eng@.", + "Wall-E is an Area120 Project building assistant powered robots. The surface is an extended joplin which have same capabilities as a google home adding custom robot features. Currently in active development. Please reach out walle-software@ or bingxin@ for questions. For details see go/walle-as-pipeline-1-pager.", + "Surface used for unit-testing purposes. Unit-tests might still require the existence of a \"valid\" SurfaceType to succeed (eg. initialization of the CapabilityBuilder, proto matching, etc.). With the move away from SurfaceType checks, a generic \"TESTING\" SurfaceType can be used for such tests without affecting the test behavior. Unlike the CAPABILITY_BASED_SURFACE, this proto does not have any capabilities or ResponseType tied to it. It should only be used for unit-tests and should not be exposed in the ASDebugger." + ], + "type": "string" + }, "surfaceType": { "description": "The device's surface type. The types are defined at google3/assistant/api/core_types/surfaces.gcl.", "enum": [ @@ -20257,8 +20393,63 @@ }, "type": "object" }, + "AssistantPfrDeviceRdMetadata": { + "id": "AssistantPfrDeviceRdMetadata", + "properties": { + "deviceName": { + "type": "string" + }, + "deviceTypes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "effectiveArgSpanLength": { + "format": "float", + "type": "number" + }, + "hasAmbiguousResolutions": { + "description": "True if there are more than one possible resolutions to the RD.", + "type": "boolean" + }, + "hasResolvedDeviceId": { + "description": "True if there's at least one device id that gets resolved. Note this is different from is_grounded = true: it is possible that is_grounded = false (num_grounded_args =0) but there is resolved device ids. E.g.: \"turn on the blue light\" Power_on(device_object = [d1, d2]:RD(category=DeviceObject(name='blue light')) where there are \"blue light 1\" and \"blue light 2\" hence two resolved device ids. But since the quantifier is single, GB can't resolve the ambiguity and would set num_grounded_args = 0 to indicate such unresolved ambiguity.", + "type": "boolean" + }, + "roomName": { + "type": "string" + } + }, + "type": "object" + }, + "AssistantPfrSmartHomeIntentMetadata": { + "description": "Used by the Smarthome Business Rules twiddler to determine whether to replace the top-scoring Smarthome intent with another.", + "id": "AssistantPfrSmartHomeIntentMetadata", + "properties": { + "deviceRdMetadata": { + "description": "Each DeviceRdMetadata represents one device RD (device slot) in the intent. Note that each device RD could have multiple device groundings inside of it.", + "items": { + "$ref": "AssistantPfrDeviceRdMetadata" + }, + "type": "array" + }, + "intentName": { + "type": "string" + }, + "isExactMatch": { + "description": "When num_constraints == num_constraints_satisfied, indicating all slot matchings are exact match.", + "type": "boolean" + }, + "isGrounded": { + "description": "When num_grounded_args \u003e 0, indicating there is at least one top-level argument is grounded.", + "type": "boolean" + } + }, + "type": "object" + }, "AssistantPrefulfillmentRankerPrefulfillmentSignals": { - "description": "Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 57", + "description": "Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 60", "id": "AssistantPrefulfillmentRankerPrefulfillmentSignals", "properties": { "bindingSetAuis": { @@ -20370,6 +20561,10 @@ "description": "Whether the intent is fully grounded.", "type": "boolean" }, + "isHighConfidencePodcastIntent": { + "description": "Used for PFR manual rule to prefer high confidence podcast intent (e.g. topical, genre) over generic podcast intents.", + "type": "boolean" + }, "isMediaControlIntent": { "description": "Whether the intent is a media control intent.", "type": "boolean" @@ -20378,6 +20573,10 @@ "description": "Whether the intent is a PlayGenericMusic-type intent.", "type": "boolean" }, + "isPodcastGenericIntent": { + "description": "Used for PFR manual rule to prefer high confidence podcast intent (e.g. topical, genre) over generic podcast intents.", + "type": "boolean" + }, "isPodcastIntent": { "description": "Whether the intent is a podcast intent.", "type": "boolean" @@ -20572,6 +20771,10 @@ ], "type": "string" }, + "smarthomeIntentMetadata": { + "$ref": "AssistantPfrSmartHomeIntentMetadata", + "description": "SmartHome intent metadata used for the SmartHome business-rules twiddler." + }, "subIntentType": { "description": "sub_intent_type differentiates between intents that share the top level intent name. For eg: for TV_FALLBACK_SEARCH_INTENT, the top level intent name must be \"Find_media\" and the media_object argument within it must be of type \"Media_unspecified\".", "enum": [ @@ -26243,7 +26446,7 @@ "type": "object" }, "DrishtiVesperEncodedThumbnail": { - "description": "The attributes of encoded thumbnail images. Next id: 7.", + "description": "The attributes of encoded thumbnail images. Next id: 8.", "id": "DrishtiVesperEncodedThumbnail", "properties": { "encodingQuality": { @@ -26271,6 +26474,10 @@ "format": "int32", "type": "integer" }, + "imageBlobId": { + "description": "The Blob ID of the thumbnail image in the Blobstore. We recommend absolute IDs with universe prefix if this field is passed across systems. The owner of this blob is also responsible for data Wipeout compliance.", + "type": "string" + }, "imageBytes": { "description": "Encoded thumbnail bytes. Prefer this over `image_string` as we are not supposed to store image bytes in a proto string field.", "format": "byte", @@ -46795,6 +47002,14 @@ "description": "The document type of the document being referenced.", "type": "boolean" }, + "documentIsLegalHoldFolder": { + "description": "Document is a folder with legal hold.", + "type": "boolean" + }, + "documentIsRetentionFolder": { + "description": "Document is a folder with retention policy.", + "type": "boolean" + }, "documentName": { "description": "Required. Name of the referenced document.", "type": "string" @@ -48188,12 +48403,14 @@ "enum": [ "TIME_FIELD_UNSPECIFIED", "CREATE_TIME", - "UPDATE_TIME" + "UPDATE_TIME", + "DISPOSITION_TIME" ], "enumDescriptions": [ "Default value.", "Earliest document create time.", - "Latest document update time." + "Latest document update time.", + "Time when document becomes mutable again." ], "type": "string" }, @@ -81192,6 +81409,7 @@ "PMW_TI", "ACCESSIBILITY_TRACKER", "DUCKIEWEB", + "MATTERSPACE", "DEPRECATED_QUICKSTART_FLUME", "DUO_CLIENT", "ALBERT", @@ -81591,7 +81809,7 @@ "Memegen! https://memegen.googleplex.com Team contact: memgegen-team@google.com", "Society App http://go/society Team contact: society-team@google.com", "Society chat application. http://go/society Team contact: society-team@google.com", - "Search Highlight http://go/seng-highlight Team contact: search-engagement-team@google.com", + "Search One Presence (Formerly Search Engagement Highlight) http://go/dumpling Team contact: team-dumpling@google.com", "YouTube Live Chat. http://go/livechat-redesign Team contact: yt-live-chat@google.com", "YouTube Live Activity log. http://go/live-chat-history-design Team contact: yt-live-chat@google.com", "YouTube Live Takeout. http://go/livechat-takeout Team contact: yt-live-chat@google.com", @@ -81836,6 +82054,7 @@ "Pmw Ti Team contact: pmw-ti", "Accessibility Tracker Team contact: a11y-tracker-eng@google.com", "Duckieweb Team contact: workflow-horizontals-core@google.com", + "Matterspace Team contact: legalworks-elm-eng@google.com, rajapate@google.com", "", "Duo Client Team contact: duo-eng@google.com", "Project albert (go/albert-frontend) Team contact: albert-eng@google.com", @@ -93663,6 +93882,12 @@ "format": "uint64", "type": "string" }, + "images": { + "items": { + "$ref": "ShoppingWebentityShoppingAnnotationProductImage" + }, + "type": "array" + }, "locale": { "$ref": "QualityShoppingShoppingAttachmentLocale" }, @@ -103286,7 +103511,7 @@ "type": "object" }, "ResearchScienceSearchReconciledMetadata": { - "description": "A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 71", + "description": "A proto for storing inferred and reconciled metadata for Science Search. Next available tag: 72", "id": "ResearchScienceSearchReconciledMetadata", "properties": { "alternateName": { @@ -103649,6 +103874,11 @@ "type": "number" }, "type": "array" + }, + "versionsSimhash": { + "description": "A simhash value of the fields used for identifying versions of a dataset. This will be used by the VersionClusterInfoWriter.", + "format": "uint64", + "type": "string" } }, "type": "object" @@ -106975,6 +107205,30 @@ }, "type": "object" }, + "ShoppingWebentityShoppingAnnotationProductImage": { + "description": "Images from the product-level representation (i.e. GPC). These images are currently only annotated 1) when no offers are available 2) on the product level", + "id": "ShoppingWebentityShoppingAnnotationProductImage", + "properties": { + "imageDocid": { + "format": "uint64", + "type": "string" + }, + "productImageType": { + "enum": [ + "PRODUCT_IMAGE_TYPE_UNKNOWN", + "PRODUCT_IMAGE_GPC", + "PRODUCT_IMAGE_TYPE_MULTIBANG_ENTITY_INFERRED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "ShoppingWebentityShoppingAnnotationProductRating": { "description": "Information about a rating provided for a product. This can represent an aggregated rating if count is set. Next Id: 7", "id": "ShoppingWebentityShoppingAnnotationProductRating", @@ -110290,6 +110544,7 @@ "ISOLATION_S12Y_RECIPE_INGREDIENT_INSIGHTS", "ISOLATION_SCOUTS_SOCIETAL_CONTEXT_ENTITIES", "ISOLATION_ASTROLOGY_HOROSCOPE", + "ISOLATION_LLM_GENERATED_TVM_SYNOPSIS", "UMP_TESTING_ONLY", "INTENTJOINS_NB_SIGNALS", "ADS_INTEGRITY_ANNOTATION", @@ -110475,6 +110730,7 @@ "For Search sustainability's food choice feature, Recipe Ingredient Insights. Assign existing KG entities feature types to classify triggering behavior and insights. Owned by salehh@ and s12y-eng@ See go/rii-kg-triggering-migration for more information.", "Access controls for SCOUTS Societal Context Repository entities. Please contact johnhenry-eng@ before reading or writing this data. DD: go/scouts-kg-integration-dd", "Access controls for Astrology Horoscope features. Please contact search-india-verticals@ before reading or writing this data. DD: go/daily-horoscope-dd", + "Access controls for LLM generated tvm synopsis. DD: go/i18n-tvm-descriptions Please contact dkrish-team@ before reading or writing this data.", "This access control is used to guard data used by the Unified Media Platform team (ke-media-actions-serving@) for testing new features. It should never be used for purposes other than testing. More context at go/fake-media-provider.", "Access controls for the IntentJoins Navboost data. YOU MUST CONTACT intentjoins-eng@ before reading or writing this data.", "Access controls for Ads Integrity annotation data. Ads Integrity annotations are only available for Ads Integrity policy enforcement. See go/ai-political-km for more details. YOU MUST CONTACT ai-pacg@ before reading or writing this data.", @@ -113881,6 +114137,7 @@ "MDP_WITH_LIVE_OPS_EVER_INSTALLED_USERS_EVENT_LEVEL", "MDP_WITH_LIVE_OPS_NEVER_INSTALLED_USERS_EVENT_LEVEL", "BROAD_RELATED_QUERIES_CLUSTER_EVENT", + "SUPPLEMENTAL_TG_RETRIEVAL_EVENT_LEVEL", "EVENT_LEVEL_TEST_CODE_LIMIT", "ENTERTAINMENT_CLUSTER_TRIGGERING_AT_SESSION_LEVEL", "BEST_SELLER_CART_TAG_AT_SESSION_LEVEL", @@ -114389,6 +114646,8 @@ "SHOULD_SEE_NOW_CLUSTER_CONTENT_PRE_REGISTRATION_NH_K2", "SHOULD_SEE_NOW_CLUSTER_CONTENT_PRE_REGISTRATION_NH_K3_4", "SHOULD_SEE_NOW_CLUSTER_CONTENT_PRE_REGISTRATION_NH_GTE_K5", + "FEATURED_PRODUCTS_LIVE_OPS_AT_SESSION_LEVEL", + "SUPPLEMENTAL_TG_RETRIEVAL_SESSION_LEVEL", "WALLET_WELLBEING_ALERT_SESSION_LEVEL", "BROAD_INTENT_REWEIGHTING_SESSION_LEVEL", "DYNASTY_DEVICE_HANDOFF_SESSION_LEVEL", @@ -114695,6 +114954,7 @@ "LOYALTY_CORPUS_WIDE_STAMP_CARD_GAMES_HOME_CLIENT_USER_LEVEL", "GROWTH_CORPUS_WIDE_STAMP_CARD_GAMES_HOME_SERVER_USER_LEVEL", "LOYALTY_PURCHASE_QUEST_GAMES_HOME_SERVER_USER_LEVEL", + "LOYALTY_PURCHASE_QUEST_SERP_SERVER_USER_LEVEL", "LOYALTY_CORPUS_WIDE_STAMP_CARD_GAMES_HOME_SERVER_USER_LEVEL", "LOYALTY_CORPUS_WIDE_STAMP_CARD_DETAILS_PAGE_SERVER_USER_LEVEL", "SUBS_HIGH_CHURN_FOP_OPTIONS_AVAILABLE_USER_LEVEL", @@ -114818,6 +115078,7 @@ "IS_ELIGIBLE_FOR_DYNAMIC_AUTH_USER_LEVEL", "GE_LIVEOPS_PSPEND_USER_LEVEL", "IS_ELIGIBLE_FOR_RENEWAL_REMINDER_USER_LEVEL", + "FEATURED_PRODUCTS_LIVE_OPS_AT_USER_LEVEL", "USER_LEVEL_TEST_CODE_LIMIT" ], "enumDescriptions": [ @@ -115082,6 +115343,7 @@ "Event-level test code for logging MDP LiveOps shown to ever-installed users on SERP", "Event-level test code for logging MDP LiveOps shown to never-installed users on SERP", "Broad Related Queries TestCode", + "Event-level test code for Supplemental TG Retrieval.", "", "", "", @@ -115590,6 +115852,8 @@ "", "", "", + "Session level test code for Featured Products LiveOps.", + "Session-level test code for Supplemental TG Retrieval.", "TestCode for slicing the users cohorts that should have received a budget Warning alert", "TestCode for Broad Intent Reweighting Session Level.", "TestCode for Dynasty Device Handoff Session Level.", @@ -115896,6 +116160,7 @@ "User level test code for Corpus Wide Loyalty Stamp Card, for tracking users who are eligible for the LSC in Games Home. This test code is logged on client side.", "User level test code for Corpus Wide Growth Stamp Card, for tracking users who are eligible for the GSC in Games Home. This test code is logged on server side.", "User level test code for Loyalty Purchase Quest, for tracking users who are eligible for the LPQ in Games Home. This test code is logged on server side.", + "User level test code for Loyalty Purchase Quest, for tracking users who are eligible for the LPQ in SERP. This test code is logged on server side.", "User level test code for Corpus Wide Loyalty Stamp Card, for tracking users who are eligible for the LSC in Games Home. This test code is logged on server side.", "User level test code for Corpus Wide Loyalty Stamp Card, for tracking users who are eligible for the LSC in Apps Details Page. This test code is logged on server side.", "User level test code that indicates that at least one high churn fop options is available for user when visiting add fop page for subscription purchase. Deprecated, use 20361 instead.", @@ -116019,6 +116284,7 @@ "User level test code for users who are eligible for dynamic auth.", "User level test code for LiveOps pSpend uplift experiment. If GE campaign decision changed after enabling pSpend model, log test code.", "User level test code for users who are eligible to see the renewal reminder button.", + "User level test code for Featured Products LiveOps.", "" ], "type": "string" @@ -132030,28 +132296,32 @@ "type": "object" }, "YoutubeBackstageSuperVodCommentInfo": { - "description": "Contains information about comment that is posted through a Super VOD purchase. Next ID: 6", + "description": "Contains information about comment that is posted through a Super Thanks purchase. Next ID: 7", "id": "YoutubeBackstageSuperVodCommentInfo", "properties": { "currencyCode": { - "description": "Currency code the user uses to purchase this Super VOD item.", + "description": "Currency code the user uses to purchase this Super Thanks item.", "type": "string" }, "entitlementId": { - "description": "The ID of the Super VOD entitlement. It uniquely identifies a Super VOD purchase.", + "description": "The ID of the Super Thanks entitlement. It uniquely identifies a Super Thanks purchase. This field is deprecated in favor of transaction_id, see go/st-deprecate-ent-id.", "type": "string" }, "priceInMicros": { - "description": "Price of Super VOD item the user purchases in micros.", + "description": "Price of Super Thanks item the user purchases in micros.", "format": "uint64", "type": "string" }, "superVodItemId": { - "description": "The Super VOD item the user purchases, it represents price tier.", + "description": "The Super Thanks item the user purchases, it represents price tier.", + "type": "string" + }, + "transactionId": { + "description": "The ID of the Super Thanks transaction. It uniquely identifies a Super Thanks purchase.", "type": "string" }, "version": { - "description": "Which version of experiment this Super VOD comment is posted in.", + "description": "Which version of experiment this Super Thanks comment is posted in.", "enum": [ "UNSPECIFIED_VERSION", "V1_DEFAULT_MESSAGE", @@ -132060,9 +132330,9 @@ ], "enumDescriptions": [ "", - "DEPRECATED since decorated comments are fully launched. Comments previously posted with this enum value will continue to exist. Undecorated Comment. When user buys a Super VOD, a comment with default message will be automatically posted on behalf of the user.", - "Decorated Comment. When user buys a Super VOD, a comment with default message and a special decoration will be automatically posted on behalf of the user. https://screenshot.googleplex.com/6aYvGnX5Bp9bT9Q", - "UGC. When user buys a Super VOD, they can write their own UGC comment which will be decorated and automatically posted on behalf of the user." + "DEPRECATED since decorated comments are fully launched. Comments previously posted with this enum value will continue to exist. Undecorated Comment. When user buys a Super Thanks, a comment with default message will be automatically posted on behalf of the user.", + "Decorated Comment. When user buys a Super Thanks, a comment with default message and a special decoration will be automatically posted on behalf of the user. https://screenshot.googleplex.com/6aYvGnX5Bp9bT9Q", + "UGC. When user buys a Super Thanks, they can write their own UGC comment which will be decorated and automatically posted on behalf of the user." ], "type": "string" } diff --git a/contentwarehouse/v1/contentwarehouse-gen.go b/contentwarehouse/v1/contentwarehouse-gen.go index f4a93cc1df4..f160c447367 100644 --- a/contentwarehouse/v1/contentwarehouse-gen.go +++ b/contentwarehouse/v1/contentwarehouse-gen.go @@ -3220,6 +3220,7 @@ type AppsPeopleOzExternalMergedpeopleapiAffinity struct { // "PLX_DATASOURCE_AFFINITY" // "DUCKIEWEB_AFFINITY" // "MEET_CALLING_AFFINITY" + // "MATTERSPACE_AFFINITY" AffinityType string `json:"affinityType,omitempty"` // ContainerId: The ID of the container @@ -3392,6 +3393,16 @@ type AppsPeopleOzExternalMergedpeopleapiAppUniqueInfo struct { // Whatsapp will be "11234567890@s.whatsapp.net" AppUniqueId string `json:"appUniqueId,omitempty"` + // ContactInfoSource: Where this contact info was retrieved from. Note: + // only added for Assistant usage, and will not be populated by PAPI. + // This is due to the coupling between Assistant Proto, and PAPI proto. + // (//depot/google3/quality/qrewrite/servlets/proto/focus_name.proto) + // + // Possible values: + // "SOURCE_UNKNOWN" + // "APP_SEARCH" - The contact info came from AppSearch. + ContactInfoSource string `json:"contactInfoSource,omitempty"` + // DisplayAppUniqueId: Store third party endpoint that is displayed to // users. For example, display_app_unique_id for Whatsapp will be // "Message +11234567890". @@ -4083,31 +4094,25 @@ func (s *AppsPeopleOzExternalMergedpeopleapiCommunicationEmail) MarshalJSON() ([ // people-prompts settings and contact-level connection reminders. Part // of go/people-prompts. type AppsPeopleOzExternalMergedpeopleapiConnectionReminder struct { - // ContactPromptSettings: Contains the Contact level settings that will - // affect all reminders. - ContactPromptSettings *SocialGraphApiProtoContactPromptSettings `json:"contactPromptSettings,omitempty"` - Metadata *AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata `json:"metadata,omitempty"` // Prompt: Contact-level "reminder to connect" prompts for this contact. Prompt []*SocialGraphApiProtoPrompt `json:"prompt,omitempty"` - // ForceSendFields is a list of field names (e.g. - // "ContactPromptSettings") to unconditionally include in API requests. - // By default, fields with empty or default values are omitted from API - // requests. However, any non-pointer, non-interface field appearing in - // ForceSendFields will be sent to the server regardless of whether the - // field is empty or not. This may be used to include empty fields in - // Patch requests. + // ForceSendFields is a list of field names (e.g. "Metadata") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ContactPromptSettings") to - // include in API requests with the JSON null value. By default, fields - // with empty values are omitted from API requests. However, any field - // with an empty value appearing in NullFields will be sent to the - // server as null. It is an error if a field in this list has a - // non-empty value. This may be used to include null fields in Patch - // requests. + // NullFields is a list of field names (e.g. "Metadata") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` } @@ -13625,11 +13630,125 @@ func (s *AssistantApiCoreTypesGovernedRingtoneTaskMetadataRoutineAlarmMetadata) // User-Agent string within the Assistant Server. Note: The // SurfaceIdentity proto should only be used to derive the capabilities // of a surface. It should not be accessed outside of the -// CapabilityBuilder or CapabilityChecker. NEXT ID: 5 LINT.IfChange +// CapabilityBuilder or CapabilityChecker. NEXT ID: 6 LINT.IfChange type AssistantApiCoreTypesGovernedSurfaceIdentity struct { // DeviceId: The identifier of the device. DeviceId *AssistantApiCoreTypesDeviceId `json:"deviceId,omitempty"` + // LegacySurfaceType: DEPRECATED: The legacy device's surface type enum. + // NOTE: Prefer using the ontological `surface_type` field above. If you + // need to access the legacy surface type, please file a bug and add it + // in your code to migrate to ontological surface type. + // + // Possible values: + // "UNKNOWN" + // "ANDROID_ALLO" + // "ANDROID_AUTO" - Deprecated (never used). Use OPA_ANDROID_AUTO + // instead. + // "ANDROID_THINGS_CUBE" - Assistant on small screen stationary + // device. + // "ANDROID_THINGS_JASPER" + // "ANDROID_TV" + // "ANDROID_TV_KIDS" + // "ANDROID_WEAR" + // "AR_GLASSES" - Assistant on AR Glasses with both visual and audio + // experiences. Ask ar-assistant@ for details. + // "ASSISTANT_SDK" - For Assistant SDK gRPC client. + // "AUDIOWEAR" + // "BUBBLE_CHARACTERS_IOS" - go/assistant-lamda-overview-characters + // "CAPABILITY_BASED_SURFACE" - Surface for capability based testing. + // "CHROMECAST_ASSISTANT" - For chrome cast assistant web app. + // "CHROMECAST_MANHATTAN" - For chrome cast with assistant + screen + // (e.g., Google Nest Hub). + // "CHROMECAST_SEARCH" + // "CLOUD_DEVICE" - Virtual device for event-based triggering, e.g. + // executing time + // "COMPANION_SCREEN" - scheduled routines: go/routine-cloud-ex For + // Quartz. + // "DYNAMITE_WEB" + // "ENSEMBLE" + // "EYESFREE_AGSA" - Deprecated. Please use OPA_ANDROID_SCREENLESS. + // "EYESFREE_GMM" + // "GBOARD" - For Gboard app + // "GLASS" + // "GOOGLE_HOME" + // "HANGOUTS_CHATBOT" + // "IOS_ALLO" + // "IOS_GSA" + // "IOS_WEAR" + // "LIBASSISTANT" - For standalone libassistant devices. + // "LINE_CHATBOT" - LINE 3P messaging app + // "MULTIMODAL_AGSA" - Deprecated. + // "NON_ASSISTANT_SURFACE" - Surfaces that do not speak to the + // Assistant, i.e. web HQ + // "OPA_AGSA" - Assistant on Android phones accessed through the + // Google App (velvet). This represents neither all of the assistant on + // android phones (ANDROID_ALLO, VERILY_ONDUO, etc.) nor all of the + // assistant built on top of AGSA (ANDROID_WEAR, OPA_ANDROID_SCREENLESS, + // OPA_AGSA_CHROME_OS, etc.). + // "OPA_AGSA_CHROME_OS" - Deprecated. Please use OPA_CROS. + // "OPA_ANDROID_AUTO" + // "OPA_ANDROID_LITE" - This is OPA on Android Go (not part of AGSA) + // "OPA_ANDROID_SCREENLESS" - Assistant on Nexus with screen + // off/locked. Use go/bisto device to trigger. + // "OPA_ANDROID_SMART_DISPLAY" - Assistant on Titan hub mode + // (go/titan-hubmode-surface). This is OPA Android first party Smart + // Display devices. The UI experience is built on Opal (Gallium and + // Flutter) and native Android. + // "OPA_ANDROID_TABLET" - Assistant on Android tablet + // "OPA_CROS" - Assistant on native Chrome OS (go/croissant). + // "OPA_GACS" - For assistant on GACS devices (go/gacs-dd). Google + // Assistant Conversation Service (GACS) defines intents the device + // accepts. This surface serves the intents in the assistant response. + // "OPA_IOS" + // "OPA_IOS_SCREENLESS" - Assistant on iOS with screen off/locked. Use + // go/bisto device to trigger. + // "OPA_KAIOS" - Assistant on KaiOS. go/kaiosama + // "OPA_MOBILE_WEB" - Assistant on Mobile Web. go/opa-spidey + // "RTOS_PHONE" - Assistant on low-cost RTOS phones (go/conceRTOS). + // "SMS_CHATBOT" + // "TELEGRAM_CHATBOT" - Telegram 3P messaging app + // "TELEPHONE_ASSISTANT" - Assistant on a phone call (go/telephone). + // "VERILY_ONDUO" + // "YOUTUBE_APP" - A Youtube app. + // "AGSA_BISTO_FOR_EVAL" - Eval-only surfaces. These surfaces are not + // real surfaces. They are only used in intermediate steps of eval query + // and request generation: 1. Eval samplers (OPA query sampler and + // Cannery sampler) checks logs and temporarily assigns these surface + // types to the logs, to put Bisto, Lockhart Mic, ... queries in the + // correct query pools. 2. Request builders uses these surface types to + // determine how TaskRequest for Bisto, Lockhart Mic, ... should be + // built, like whether some user user agent should be used, whether some + // entry source should be set. The surface types in the generated + // TaskRequest is still the production surface types, like + // OPA_ANDROID_SCREENLESS or OPA_AGSA. Temp surface for Bisto Android + // eval. Will be merged with OPA_ANDROID_SCREENLESS in the future. + // "COGSWORTH_FOR_EVAL" + // "LOCKHART_MIC_FOR_EVAL" + // "OPA_ANDROID_AUTO_EMBEDDED_FAKE" - OPA_ANDROID_AUTO has another + // sub-surface (embedded) that differs in the reported capabilities, + // client-ops, flags but uses the same surface_type string of + // OPA_ANDROID_AUTO. This fake surface would allow running turing2 tests + // and evals for this embedded surface. Deprecated as of Feb 2019. + // Please use "OPA_ANDROID_AUTO_EMBEDDED" client type for tests and + // eval. See go/client-onboarding for more details. + // https://cs.corp.google.com/piper///depot/google3/assistant/assistant_server/tools/util/consts.h?l=32&rcl=247481455 + // "SPARK" - Unlaunched new surface prototype, ask spark-eng@. + // "WALLE" - Wall-E is an Area120 Project building assistant powered + // robots. The surface is an extended joplin which have same + // capabilities as a google home adding custom robot features. Currently + // in active development. Please reach out walle-software@ or bingxin@ + // for questions. For details see go/walle-as-pipeline-1-pager. + // "UNIT_TESTING" - Surface used for unit-testing purposes. Unit-tests + // might still require the existence of a "valid" SurfaceType to succeed + // (eg. initialization of the CapabilityBuilder, proto matching, etc.). + // With the move away from SurfaceType checks, a generic "TESTING" + // SurfaceType can be used for such tests without affecting the test + // behavior. Unlike the CAPABILITY_BASED_SURFACE, this proto does not + // have any capabilities or ResponseType tied to it. It should only be + // used for unit-tests and should not be exposed in the ASDebugger. + LegacySurfaceType string `json:"legacySurfaceType,omitempty"` + // SurfaceType: The device's surface type. The types are defined at // google3/assistant/api/core_types/surfaces.gcl. // @@ -26191,10 +26310,114 @@ func (s *AssistantLogsTargetDeviceLog) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +type AssistantPfrDeviceRdMetadata struct { + DeviceName string `json:"deviceName,omitempty"` + + DeviceTypes []string `json:"deviceTypes,omitempty"` + + EffectiveArgSpanLength float64 `json:"effectiveArgSpanLength,omitempty"` + + // HasAmbiguousResolutions: True if there are more than one possible + // resolutions to the RD. + HasAmbiguousResolutions bool `json:"hasAmbiguousResolutions,omitempty"` + + // HasResolvedDeviceId: True if there's at least one device id that gets + // resolved. Note this is different from is_grounded = true: it is + // possible that is_grounded = false (num_grounded_args =0) but there is + // resolved device ids. E.g.: "turn on the blue light" + // Power_on(device_object = [d1, d2]:RD(category=DeviceObject(name='blue + // light')) where there are "blue light 1" and "blue light 2" hence two + // resolved device ids. But since the quantifier is single, GB can't + // resolve the ambiguity and would set num_grounded_args = 0 to indicate + // such unresolved ambiguity. + HasResolvedDeviceId bool `json:"hasResolvedDeviceId,omitempty"` + + RoomName string `json:"roomName,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DeviceName") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DeviceName") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *AssistantPfrDeviceRdMetadata) MarshalJSON() ([]byte, error) { + type NoMethod AssistantPfrDeviceRdMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *AssistantPfrDeviceRdMetadata) UnmarshalJSON(data []byte) error { + type NoMethod AssistantPfrDeviceRdMetadata + var s1 struct { + EffectiveArgSpanLength gensupport.JSONFloat64 `json:"effectiveArgSpanLength"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.EffectiveArgSpanLength = float64(s1.EffectiveArgSpanLength) + return nil +} + +// AssistantPfrSmartHomeIntentMetadata: Used by the Smarthome Business +// Rules twiddler to determine whether to replace the top-scoring +// Smarthome intent with another. +type AssistantPfrSmartHomeIntentMetadata struct { + // DeviceRdMetadata: Each DeviceRdMetadata represents one device RD + // (device slot) in the intent. Note that each device RD could have + // multiple device groundings inside of it. + DeviceRdMetadata []*AssistantPfrDeviceRdMetadata `json:"deviceRdMetadata,omitempty"` + + IntentName string `json:"intentName,omitempty"` + + // IsExactMatch: When num_constraints == num_constraints_satisfied, + // indicating all slot matchings are exact match. + IsExactMatch bool `json:"isExactMatch,omitempty"` + + // IsGrounded: When num_grounded_args > 0, indicating there is at least + // one top-level argument is grounded. + IsGrounded bool `json:"isGrounded,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DeviceRdMetadata") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DeviceRdMetadata") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *AssistantPfrSmartHomeIntentMetadata) MarshalJSON() ([]byte, error) { + type NoMethod AssistantPfrSmartHomeIntentMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // AssistantPrefulfillmentRankerPrefulfillmentSignals: Signals to be // used by the Prefulfillment Ranker. Derived from the ParsingSignals // and GroundingSignals carried by the FunctionCall. LINT.IfChange Next -// ID: 57 +// ID: 60 type AssistantPrefulfillmentRankerPrefulfillmentSignals struct { // BindingSetAuis: Assistant User Interaction Score for binding set. BindingSetAuis float64 `json:"bindingSetAuis,omitempty"` @@ -26300,6 +26523,11 @@ type AssistantPrefulfillmentRankerPrefulfillmentSignals struct { // IsFullyGrounded: Whether the intent is fully grounded. IsFullyGrounded bool `json:"isFullyGrounded,omitempty"` + // IsHighConfidencePodcastIntent: Used for PFR manual rule to prefer + // high confidence podcast intent (e.g. topical, genre) over generic + // podcast intents. + IsHighConfidencePodcastIntent bool `json:"isHighConfidencePodcastIntent,omitempty"` + // IsMediaControlIntent: Whether the intent is a media control intent. IsMediaControlIntent bool `json:"isMediaControlIntent,omitempty"` @@ -26307,6 +26535,11 @@ type AssistantPrefulfillmentRankerPrefulfillmentSignals struct { // intent. IsPlayGenericMusic bool `json:"isPlayGenericMusic,omitempty"` + // IsPodcastGenericIntent: Used for PFR manual rule to prefer high + // confidence podcast intent (e.g. topical, genre) over generic podcast + // intents. + IsPodcastGenericIntent bool `json:"isPodcastGenericIntent,omitempty"` + // IsPodcastIntent: Whether the intent is a podcast intent. IsPodcastIntent bool `json:"isPodcastIntent,omitempty"` @@ -26492,6 +26725,10 @@ type AssistantPrefulfillmentRankerPrefulfillmentSignals struct { // for the suppression for intents lower in the list. SearchDispatch string `json:"searchDispatch,omitempty"` + // SmarthomeIntentMetadata: SmartHome intent metadata used for the + // SmartHome business-rules twiddler. + SmarthomeIntentMetadata *AssistantPfrSmartHomeIntentMetadata `json:"smarthomeIntentMetadata,omitempty"` + // SubIntentType: sub_intent_type differentiates between intents that // share the top level intent name. For eg: for // TV_FALLBACK_SEARCH_INTENT, the top level intent name must be @@ -34534,7 +34771,7 @@ func (s *DrishtiSparseFeatureData) UnmarshalJSON(data []byte) error { } // DrishtiVesperEncodedThumbnail: The attributes of encoded thumbnail -// images. Next id: 7. +// images. Next id: 8. type DrishtiVesperEncodedThumbnail struct { // EncodingQuality: JPEG/WEBP quality factor in range [0,100]. EncodingQuality int64 `json:"encodingQuality,omitempty"` @@ -34550,6 +34787,12 @@ type DrishtiVesperEncodedThumbnail struct { Height int64 `json:"height,omitempty"` + // ImageBlobId: The Blob ID of the thumbnail image in the Blobstore. We + // recommend absolute IDs with universe prefix if this field is passed + // across systems. The owner of this blob is also responsible for data + // Wipeout compliance. + ImageBlobId string `json:"imageBlobId,omitempty"` + // ImageBytes: Encoded thumbnail bytes. Prefer this over `image_string` // as we are not supposed to store image bytes in a proto string field. ImageBytes string `json:"imageBytes,omitempty"` @@ -58198,6 +58441,13 @@ type GoogleCloudContentwarehouseV1DocumentReference struct { // DocumentIsFolder: The document type of the document being referenced. DocumentIsFolder bool `json:"documentIsFolder,omitempty"` + // DocumentIsLegalHoldFolder: Document is a folder with legal hold. + DocumentIsLegalHoldFolder bool `json:"documentIsLegalHoldFolder,omitempty"` + + // DocumentIsRetentionFolder: Document is a folder with retention + // policy. + DocumentIsRetentionFolder bool `json:"documentIsRetentionFolder,omitempty"` + // DocumentName: Required. Name of the referenced document. DocumentName string `json:"documentName,omitempty"` @@ -60712,6 +60962,7 @@ type GoogleCloudContentwarehouseV1TimeFilter struct { // "TIME_FIELD_UNSPECIFIED" - Default value. // "CREATE_TIME" - Earliest document create time. // "UPDATE_TIME" - Latest document update time. + // "DISPOSITION_TIME" - Time when document becomes mutable again. TimeField string `json:"timeField,omitempty"` TimeRange *GoogleTypeInterval `json:"timeRange,omitempty"` @@ -103373,8 +103624,8 @@ type PeoplestackFlexorgsProtoInternalExternal struct { // society-team@google.com // "SOCIETY_CHAT" - Society chat application. http://go/society Team // contact: society-team@google.com - // "HIGHLIGHT" - Search Highlight http://go/seng-highlight Team - // contact: search-engagement-team@google.com + // "HIGHLIGHT" - Search One Presence (Formerly Search Engagement + // Highlight) http://go/dumpling Team contact: team-dumpling@google.com // "YOUTUBE_LIVE" - YouTube Live Chat. http://go/livechat-redesign // Team contact: yt-live-chat@google.com // "YOUTUBE_LIVE_ACTIVITY_LOG" - YouTube Live Activity log. @@ -103835,6 +104086,8 @@ type PeoplestackFlexorgsProtoInternalExternal struct { // a11y-tracker-eng@google.com // "DUCKIEWEB" - Duckieweb Team contact: // workflow-horizontals-core@google.com + // "MATTERSPACE" - Matterspace Team contact: + // legalworks-elm-eng@google.com, rajapate@google.com // "DEPRECATED_QUICKSTART_FLUME" // "DUO_CLIENT" - Duo Client Team contact: duo-eng@google.com // "ALBERT" - Project albert (go/albert-frontend) Team contact: @@ -116709,6 +116962,8 @@ type QualityShoppingShoppingAttachmentProduct struct { GlobalProductClusterId uint64 `json:"globalProductClusterId,omitempty,string"` + Images []*ShoppingWebentityShoppingAnnotationProductImage `json:"images,omitempty"` + Locale *QualityShoppingShoppingAttachmentLocale `json:"locale,omitempty"` MokaFacet []*QualityShoppingShoppingAttachmentMokaFacetValue `json:"mokaFacet,omitempty"` @@ -130083,7 +130338,7 @@ func (s *ResearchScienceSearchOrganization) MarshalJSON() ([]byte, error) { } // ResearchScienceSearchReconciledMetadata: A proto for storing inferred -// and reconciled metadata for Science Search. Next available tag: 71 +// and reconciled metadata for Science Search. Next available tag: 72 type ResearchScienceSearchReconciledMetadata struct { // AlternateName: Alternate names and acronyms for the dataset. AlternateName []string `json:"alternateName,omitempty"` @@ -130341,6 +130596,11 @@ type ResearchScienceSearchReconciledMetadata struct { // the VersionAggregator. VersionEmbeddingVector []float64 `json:"versionEmbeddingVector,omitempty"` + // VersionsSimhash: A simhash value of the fields used for identifying + // versions of a dataset. This will be used by the + // VersionClusterInfoWriter. + VersionsSimhash uint64 `json:"versionsSimhash,omitempty,string"` + // ForceSendFields is a list of field names (e.g. "AlternateName") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -134604,6 +134864,42 @@ func (s *ShoppingWebentityShoppingAnnotationOfferAvailabilityInfo) MarshalJSON() return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// ShoppingWebentityShoppingAnnotationProductImage: Images from the +// product-level representation (i.e. GPC). These images are currently +// only annotated 1) when no offers are available 2) on the product +// level +type ShoppingWebentityShoppingAnnotationProductImage struct { + ImageDocid uint64 `json:"imageDocid,omitempty,string"` + + // Possible values: + // "PRODUCT_IMAGE_TYPE_UNKNOWN" + // "PRODUCT_IMAGE_GPC" + // "PRODUCT_IMAGE_TYPE_MULTIBANG_ENTITY_INFERRED" + ProductImageType string `json:"productImageType,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ImageDocid") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ImageDocid") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ShoppingWebentityShoppingAnnotationProductImage) MarshalJSON() ([]byte, error) { + type NoMethod ShoppingWebentityShoppingAnnotationProductImage + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // ShoppingWebentityShoppingAnnotationProductRating: Information about a // rating provided for a product. This can represent an aggregated // rating if count is set. Next Id: 7 @@ -140400,6 +140696,9 @@ type StorageGraphBfgTripleProvenance struct { // "ISOLATION_ASTROLOGY_HOROSCOPE" - Access controls for Astrology // Horoscope features. Please contact search-india-verticals@ before // reading or writing this data. DD: go/daily-horoscope-dd + // "ISOLATION_LLM_GENERATED_TVM_SYNOPSIS" - Access controls for LLM + // generated tvm synopsis. DD: go/i18n-tvm-descriptions Please contact + // dkrish-team@ before reading or writing this data. // "UMP_TESTING_ONLY" - This access control is used to guard data used // by the Unified Media Platform team (ke-media-actions-serving@) for // testing new features. It should never be used for purposes other than @@ -144769,6 +145068,8 @@ type VendingConsumerProtoTrustedGenomeAnnotation struct { // SERP // "BROAD_RELATED_QUERIES_CLUSTER_EVENT" - Broad Related Queries // TestCode + // "SUPPLEMENTAL_TG_RETRIEVAL_EVENT_LEVEL" - Event-level test code for + // Supplemental TG Retrieval. // "EVENT_LEVEL_TEST_CODE_LIMIT" // "ENTERTAINMENT_CLUSTER_TRIGGERING_AT_SESSION_LEVEL" // "BEST_SELLER_CART_TAG_AT_SESSION_LEVEL" @@ -145499,6 +145800,10 @@ type VendingConsumerProtoTrustedGenomeAnnotation struct { // "SHOULD_SEE_NOW_CLUSTER_CONTENT_PRE_REGISTRATION_NH_K2" // "SHOULD_SEE_NOW_CLUSTER_CONTENT_PRE_REGISTRATION_NH_K3_4" // "SHOULD_SEE_NOW_CLUSTER_CONTENT_PRE_REGISTRATION_NH_GTE_K5" + // "FEATURED_PRODUCTS_LIVE_OPS_AT_SESSION_LEVEL" - Session level test + // code for Featured Products LiveOps. + // "SUPPLEMENTAL_TG_RETRIEVAL_SESSION_LEVEL" - Session-level test code + // for Supplemental TG Retrieval. // "WALLET_WELLBEING_ALERT_SESSION_LEVEL" - TestCode for slicing the // users cohorts that should have received a budget Warning alert // "BROAD_INTENT_REWEIGHTING_SESSION_LEVEL" - TestCode for Broad @@ -146049,6 +146354,9 @@ type VendingConsumerProtoTrustedGenomeAnnotation struct { // test code for Loyalty Purchase Quest, for tracking users who are // eligible for the LPQ in Games Home. This test code is logged on // server side. + // "LOYALTY_PURCHASE_QUEST_SERP_SERVER_USER_LEVEL" - User level test + // code for Loyalty Purchase Quest, for tracking users who are eligible + // for the LPQ in SERP. This test code is logged on server side. // "LOYALTY_CORPUS_WIDE_STAMP_CARD_GAMES_HOME_SERVER_USER_LEVEL" - // User level test code for Corpus Wide Loyalty Stamp Card, for tracking // users who are eligible for the LSC in Games Home. This test code is @@ -146312,6 +146620,8 @@ type VendingConsumerProtoTrustedGenomeAnnotation struct { // enabling pSpend model, log test code. // "IS_ELIGIBLE_FOR_RENEWAL_REMINDER_USER_LEVEL" - User level test // code for users who are eligible to see the renewal reminder button. + // "FEATURED_PRODUCTS_LIVE_OPS_AT_USER_LEVEL" - User level test code + // for Featured Products LiveOps. // "USER_LEVEL_TEST_CODE_LIMIT" TestCode []string `json:"testCode,omitempty"` @@ -161648,39 +161958,45 @@ func (s *WirelessTranscoderFetchFetchSourceInfo) MarshalJSON() ([]byte, error) { } // YoutubeBackstageSuperVodCommentInfo: Contains information about -// comment that is posted through a Super VOD purchase. Next ID: 6 +// comment that is posted through a Super Thanks purchase. Next ID: 7 type YoutubeBackstageSuperVodCommentInfo struct { - // CurrencyCode: Currency code the user uses to purchase this Super VOD - // item. + // CurrencyCode: Currency code the user uses to purchase this Super + // Thanks item. CurrencyCode string `json:"currencyCode,omitempty"` - // EntitlementId: The ID of the Super VOD entitlement. It uniquely - // identifies a Super VOD purchase. + // EntitlementId: The ID of the Super Thanks entitlement. It uniquely + // identifies a Super Thanks purchase. This field is deprecated in favor + // of transaction_id, see go/st-deprecate-ent-id. EntitlementId string `json:"entitlementId,omitempty"` - // PriceInMicros: Price of Super VOD item the user purchases in micros. + // PriceInMicros: Price of Super Thanks item the user purchases in + // micros. PriceInMicros uint64 `json:"priceInMicros,omitempty,string"` - // SuperVodItemId: The Super VOD item the user purchases, it represents - // price tier. + // SuperVodItemId: The Super Thanks item the user purchases, it + // represents price tier. SuperVodItemId string `json:"superVodItemId,omitempty"` - // Version: Which version of experiment this Super VOD comment is posted - // in. + // TransactionId: The ID of the Super Thanks transaction. It uniquely + // identifies a Super Thanks purchase. + TransactionId string `json:"transactionId,omitempty"` + + // Version: Which version of experiment this Super Thanks comment is + // posted in. // // Possible values: // "UNSPECIFIED_VERSION" // "V1_DEFAULT_MESSAGE" - DEPRECATED since decorated comments are // fully launched. Comments previously posted with this enum value will - // continue to exist. Undecorated Comment. When user buys a Super VOD, a - // comment with default message will be automatically posted on behalf - // of the user. + // continue to exist. Undecorated Comment. When user buys a Super + // Thanks, a comment with default message will be automatically posted + // on behalf of the user. // "V2_DECORATED_DEFAULT_MESSAGE" - Decorated Comment. When user buys - // a Super VOD, a comment with default message and a special decoration - // will be automatically posted on behalf of the user. + // a Super Thanks, a comment with default message and a special + // decoration will be automatically posted on behalf of the user. // https://screenshot.googleplex.com/6aYvGnX5Bp9bT9Q - // "V3_USER_GENERATED_MESSAGE" - UGC. When user buys a Super VOD, they - // can write their own UGC comment which will be decorated and + // "V3_USER_GENERATED_MESSAGE" - UGC. When user buys a Super Thanks, + // they can write their own UGC comment which will be decorated and // automatically posted on behalf of the user. Version string `json:"version,omitempty"` diff --git a/dataflow/v1b3/dataflow-api.json b/dataflow/v1b3/dataflow-api.json index 448a3e3f1ba..045edbea4ce 100644 --- a/dataflow/v1b3/dataflow-api.json +++ b/dataflow/v1b3/dataflow-api.json @@ -576,7 +576,7 @@ "type": "string" }, "updateMask": { - "description": "The list of fields to update relative to Job. If empty, only RequestedJobState will be considered for update. If the FieldMask is not empty and RequestedJobState is none/empty, The fields specified in the update mask will be the only ones considered for update. If both RequestedJobState and update_mask are specified, we will first handle RequestedJobState and then the update_mask fields.", + "description": "The list of fields to update relative to Job. If empty, only RequestedJobState will be considered for update. If the FieldMask is not empty and RequestedJobState is none/empty, The fields specified in the update mask will be the only ones considered for update. If both RequestedJobState and update_mask are specified, an error will be returned as we cannot update both state and mask.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1302,7 +1302,7 @@ "type": "string" }, "updateMask": { - "description": "The list of fields to update relative to Job. If empty, only RequestedJobState will be considered for update. If the FieldMask is not empty and RequestedJobState is none/empty, The fields specified in the update mask will be the only ones considered for update. If both RequestedJobState and update_mask are specified, we will first handle RequestedJobState and then the update_mask fields.", + "description": "The list of fields to update relative to Job. If empty, only RequestedJobState will be considered for update. If the FieldMask is not empty and RequestedJobState is none/empty, The fields specified in the update mask will be the only ones considered for update. If both RequestedJobState and update_mask are specified, an error will be returned as we cannot update both state and mask.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2214,7 +2214,7 @@ } } }, - "revision": "20230529", + "revision": "20230619", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -4700,6 +4700,13 @@ "description": "Optional. Additional metadata for describing this parameter.", "type": "object" }, + "enumOptions": { + "description": "Optional. The options shown when ENUM ParameterType is specified.", + "items": { + "$ref": "ParameterMetadataEnumOption" + }, + "type": "array" + }, "groupName": { "description": "Optional. Specifies a group name for this parameter to be rendered under. Group header text will be rendered exactly as specified in this field. Only considered when parent_name is NOT provided.", "type": "string" @@ -4739,7 +4746,9 @@ "MACHINE_TYPE", "KMS_KEY_NAME", "WORKER_REGION", - "WORKER_ZONE" + "WORKER_ZONE", + "BOOLEAN", + "ENUM" ], "enumDescriptions": [ "Default input type.", @@ -4758,7 +4767,9 @@ "The parameter specifies a Machine Type.", "The parameter specifies a KMS Key name.", "The parameter specifies a Worker Region.", - "The parameter specifies a Worker Zone." + "The parameter specifies a Worker Zone.", + "The parameter specifies a boolean input.", + "The parameter specifies an enum input." ], "type": "string" }, @@ -4783,6 +4794,25 @@ }, "type": "object" }, + "ParameterMetadataEnumOption": { + "description": "ParameterMetadataEnumOption specifies the option shown in the enum form.", + "id": "ParameterMetadataEnumOption", + "properties": { + "description": { + "description": "Optional. The description to display for the enum option.", + "type": "string" + }, + "label": { + "description": "Optional. The label to display for the enum option.", + "type": "string" + }, + "value": { + "description": "Required. The value of the enum option.", + "type": "string" + } + }, + "type": "object" + }, "PartialGroupByKeyInstruction": { "description": "An instruction that does a partial group-by-key. One input and one output.", "id": "PartialGroupByKeyInstruction", diff --git a/dataflow/v1b3/dataflow-gen.go b/dataflow/v1b3/dataflow-gen.go index fe6feecd9b2..95e9b304882 100644 --- a/dataflow/v1b3/dataflow-gen.go +++ b/dataflow/v1b3/dataflow-gen.go @@ -4348,6 +4348,10 @@ type ParameterMetadata struct { // parameter. CustomMetadata map[string]string `json:"customMetadata,omitempty"` + // EnumOptions: Optional. The options shown when ENUM ParameterType is + // specified. + EnumOptions []*ParameterMetadataEnumOption `json:"enumOptions,omitempty"` + // GroupName: Optional. Specifies a group name for this parameter to be // rendered under. Group header text will be rendered exactly as // specified in this field. Only considered when parent_name is NOT @@ -4397,6 +4401,8 @@ type ParameterMetadata struct { // "KMS_KEY_NAME" - The parameter specifies a KMS Key name. // "WORKER_REGION" - The parameter specifies a Worker Region. // "WORKER_ZONE" - The parameter specifies a Worker Zone. + // "BOOLEAN" - The parameter specifies a boolean input. + // "ENUM" - The parameter specifies an enum input. ParamType string `json:"paramType,omitempty"` // ParentName: Optional. Specifies the name of the parent parameter. @@ -4439,6 +4445,42 @@ func (s *ParameterMetadata) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// ParameterMetadataEnumOption: ParameterMetadataEnumOption specifies +// the option shown in the enum form. +type ParameterMetadataEnumOption struct { + // Description: Optional. The description to display for the enum + // option. + Description string `json:"description,omitempty"` + + // Label: Optional. The label to display for the enum option. + Label string `json:"label,omitempty"` + + // Value: Required. The value of the enum option. + Value string `json:"value,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Description") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Description") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ParameterMetadataEnumOption) MarshalJSON() ([]byte, error) { + type NoMethod ParameterMetadataEnumOption + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // PartialGroupByKeyInstruction: An instruction that does a partial // group-by-key. One input and one output. type PartialGroupByKeyInstruction struct { @@ -10157,8 +10199,8 @@ func (c *ProjectsJobsUpdateCall) Location(location string) *ProjectsJobsUpdateCa // will be considered for update. If the FieldMask is not empty and // RequestedJobState is none/empty, The fields specified in the update // mask will be the only ones considered for update. If both -// RequestedJobState and update_mask are specified, we will first handle -// RequestedJobState and then the update_mask fields. +// RequestedJobState and update_mask are specified, an error will be +// returned as we cannot update both state and mask. func (c *ProjectsJobsUpdateCall) UpdateMask(updateMask string) *ProjectsJobsUpdateCall { c.urlParams_.Set("updateMask", updateMask) return c @@ -10283,7 +10325,7 @@ func (c *ProjectsJobsUpdateCall) Do(opts ...googleapi.CallOption) (*Job, error) // "type": "string" // }, // "updateMask": { - // "description": "The list of fields to update relative to Job. If empty, only RequestedJobState will be considered for update. If the FieldMask is not empty and RequestedJobState is none/empty, The fields specified in the update mask will be the only ones considered for update. If both RequestedJobState and update_mask are specified, we will first handle RequestedJobState and then the update_mask fields.", + // "description": "The list of fields to update relative to Job. If empty, only RequestedJobState will be considered for update. If the FieldMask is not empty and RequestedJobState is none/empty, The fields specified in the update mask will be the only ones considered for update. If both RequestedJobState and update_mask are specified, an error will be returned as we cannot update both state and mask.", // "format": "google-fieldmask", // "location": "query", // "type": "string" @@ -12961,8 +13003,8 @@ func (r *ProjectsLocationsJobsService) Update(projectId string, location string, // will be considered for update. If the FieldMask is not empty and // RequestedJobState is none/empty, The fields specified in the update // mask will be the only ones considered for update. If both -// RequestedJobState and update_mask are specified, we will first handle -// RequestedJobState and then the update_mask fields. +// RequestedJobState and update_mask are specified, an error will be +// returned as we cannot update both state and mask. func (c *ProjectsLocationsJobsUpdateCall) UpdateMask(updateMask string) *ProjectsLocationsJobsUpdateCall { c.urlParams_.Set("updateMask", updateMask) return c @@ -13090,7 +13132,7 @@ func (c *ProjectsLocationsJobsUpdateCall) Do(opts ...googleapi.CallOption) (*Job // "type": "string" // }, // "updateMask": { - // "description": "The list of fields to update relative to Job. If empty, only RequestedJobState will be considered for update. If the FieldMask is not empty and RequestedJobState is none/empty, The fields specified in the update mask will be the only ones considered for update. If both RequestedJobState and update_mask are specified, we will first handle RequestedJobState and then the update_mask fields.", + // "description": "The list of fields to update relative to Job. If empty, only RequestedJobState will be considered for update. If the FieldMask is not empty and RequestedJobState is none/empty, The fields specified in the update mask will be the only ones considered for update. If both RequestedJobState and update_mask are specified, an error will be returned as we cannot update both state and mask.", // "format": "google-fieldmask", // "location": "query", // "type": "string" diff --git a/dialogflow/v3/dialogflow-api.json b/dialogflow/v3/dialogflow-api.json index 2b1b77e4a69..a60a9630322 100644 --- a/dialogflow/v3/dialogflow-api.json +++ b/dialogflow/v3/dialogflow-api.json @@ -3253,7 +3253,7 @@ ] }, "list": { - "description": "Fetches a list of results for a given test case.", + "description": "Fetches the list of run results for the given test case. A maximum of 100 results are kept for each test case.", "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}/results", "httpMethod": "GET", "id": "dialogflow.projects.locations.agents.testCases.results.list", @@ -3820,7 +3820,7 @@ } } }, - "revision": "20230621", + "revision": "20230626", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { diff --git a/dialogflow/v3/dialogflow-gen.go b/dialogflow/v3/dialogflow-gen.go index 62eec59cc22..be0a76c75e3 100644 --- a/dialogflow/v3/dialogflow-gen.go +++ b/dialogflow/v3/dialogflow-gen.go @@ -35815,7 +35815,8 @@ type ProjectsLocationsAgentsTestCasesResultsListCall struct { header_ http.Header } -// List: Fetches a list of results for a given test case. +// List: Fetches the list of run results for the given test case. A +// maximum of 100 results are kept for each test case. // // - parent: The test case to list results for. Format: // `projects//locations//agents// testCases/`. Specify a `-` as a @@ -35961,7 +35962,7 @@ func (c *ProjectsLocationsAgentsTestCasesResultsListCall) Do(opts ...googleapi.C } return ret, nil // { - // "description": "Fetches a list of results for a given test case.", + // "description": "Fetches the list of run results for the given test case. A maximum of 100 results are kept for each test case.", // "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/testCases/{testCasesId}/results", // "httpMethod": "GET", // "id": "dialogflow.projects.locations.agents.testCases.results.list", diff --git a/discoveryengine/v1alpha/discoveryengine-api.json b/discoveryengine/v1alpha/discoveryengine-api.json index 8ab2db675ad..d128444dbbc 100644 --- a/discoveryengine/v1alpha/discoveryengine-api.json +++ b/discoveryengine/v1alpha/discoveryengine-api.json @@ -249,7 +249,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", + "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", "required": true, @@ -652,7 +652,7 @@ "userEvents": { "methods": { "collect": { - "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", + "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:collect", "httpMethod": "GET", "id": "discoveryengine.projects.locations.collections.dataStores.userEvents.collect", @@ -674,7 +674,7 @@ "type": "string" }, "uri": { - "description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.", + "description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", "location": "query", "type": "string" }, @@ -1064,7 +1064,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", + "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", "required": true, @@ -1393,7 +1393,7 @@ "userEvents": { "methods": { "collect": { - "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", + "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:collect", "httpMethod": "GET", "id": "discoveryengine.projects.locations.dataStores.userEvents.collect", @@ -1415,7 +1415,7 @@ "type": "string" }, "uri": { - "description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.", + "description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", "location": "query", "type": "string" }, @@ -1666,7 +1666,7 @@ } } }, - "revision": "20230620", + "revision": "20230623", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -1816,7 +1816,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata": { - "description": "Metadata related to the progress of the ImportDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata", "properties": { "createTime": { @@ -1865,14 +1865,14 @@ "id": "GoogleCloudDiscoveryengineV1ImportErrorConfig", "properties": { "gcsPrefix": { - "description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", + "description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata": { - "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata", "properties": { "createTime": { @@ -2014,7 +2014,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", "properties": { "dataSchema": { - "description": "The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.", + "description": "The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.", "type": "string" }, "datasetId": { @@ -2045,12 +2045,12 @@ "id": "GoogleCloudDiscoveryengineV1alphaCompletionInfo", "properties": { "selectedPosition": { - "description": "End user selected CompleteQueryResponse.CompletionResult.suggestion position, starting from 0.", + "description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0.", "format": "int32", "type": "integer" }, "selectedSuggestion": { - "description": "End user selected CompleteQueryResponse.CompletionResult.suggestion.", + "description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion.", "type": "string" } }, @@ -2087,7 +2087,7 @@ "type": "string" }, "jsonData": { - "description": "The JSON string representation of the document. It should conform to the registered Schema.schema or an `INVALID_ARGUMENT` error is thrown.", + "description": "The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.", "type": "string" }, "name": { @@ -2107,7 +2107,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The structured JSON data for the document. It should conform to the registered Schema.schema or an `INVALID_ARGUMENT` error is thrown.", + "description": "The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.", "type": "object" } }, @@ -2138,7 +2138,7 @@ "type": "integer" }, "uri": { - "description": "The Document url - only allowed for DataStores with content_config PUBLIC_WEBSITE.", + "description": "The Document URI - only allowed for website data stores.", "type": "string" } }, @@ -2149,7 +2149,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaGcsSource", "properties": { "dataSchema": { - "description": "The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` will become a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming the defined Schema of the data store. Each entry after the header will be imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.", + "description": "The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.", "type": "string" }, "inputUris": { @@ -2163,7 +2163,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": { - "description": "Metadata related to the progress of the ImportDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata", "properties": { "createTime": { @@ -2194,7 +2194,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest", "properties": { "autoGenerateIds": { - "description": "Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwises, documents without IDs will fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.", + "description": "Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.", "type": "boolean" }, "bigquerySource": { @@ -2210,7 +2210,7 @@ "description": "Cloud Storage location for the input content." }, "idField": { - "description": "The field in the Cloud Storage and BigQuery sources that indicates the unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{\"my_id\": \"some_uuid\"}`. For BigQuerySource it is the column name of the BigQuery table where the unique ids are stored. The values of the JSON field or the BigQuery column will be used as the Document.ids. The JSON field or the BigQuery column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs will fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is `custom`. And only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources.", + "description": "The field in the Cloud Storage and BigQuery sources that indicates the unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{\"my_id\": \"some_uuid\"}`. For BigQuerySource it is the column name of the BigQuery table where the unique ids are stored. The values of the JSON field or the BigQuery column are used as the Document.ids. The JSON field or the BigQuery column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is `custom`. And only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources.", "type": "string" }, "inlineSource": { @@ -2271,14 +2271,14 @@ "id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", "properties": { "gcsPrefix": { - "description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", + "description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": { - "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata", "properties": { "createTime": { @@ -2409,11 +2409,11 @@ "id": "GoogleCloudDiscoveryengineV1alphaPageInfo", "properties": { "pageCategory": { - "description": "The most specific category associated with a category page. To represent full path of category, use '\u003e' sign to separate different hierarchies. If '\u003e' is part of the category name, please replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: \"pageCategory\" : \"Sales \u003e 2017 Black Friday Deals\". Required for `view-category-page` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "The most specific category associated with a category page. To represent full path of category, use '\u003e' sign to separate different hierarchies. If '\u003e' is part of the category name, please replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `\"pageCategory\" : \"Sales \u003e 2017 Black Friday Deals\"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" }, "pageviewId": { - "description": "A unique ID of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The `pageViewId` property should be kept the same for all these events so that they can be grouped together properly. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.", + "description": "A unique ID of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The `pageview_id` property should be kept the same for all these events so that they can be grouped together properly. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.", "type": "string" }, "referrerUri": { @@ -2684,16 +2684,16 @@ "id": "GoogleCloudDiscoveryengineV1alphaSearchInfo", "properties": { "offset": { - "description": "An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant). See SearchRequest.offset for definition. If this field is negative, an INVALID_ARGUMENT is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant). See SearchRequest.offset for definition. If this field is negative, an `INVALID_ARGUMENT` is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.", "format": "int32", "type": "integer" }, "orderBy": { - "description": "The order in which products are returned, if applicable. See SearchRequest.order_by for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "The order in which products are returned, if applicable. See SearchRequest.order_by for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" }, "searchQuery": { - "description": "The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, @@ -2704,7 +2704,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaTargetSite", "properties": { "exactMatch": { - "description": "Input only. If set to false, an uri_pattern will be generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern will be generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern will always be normalized to generate the uri pattern to be used by the search engine.", + "description": "Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.", "type": "boolean" }, "generatedUriPattern": { @@ -2718,7 +2718,7 @@ "type": "string" }, "providedUriPattern": { - "description": "Required. Input only. The user provided uri pattern from which the `generated_uri_pattern` is generated.", + "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", "type": "string" }, "type": { @@ -2787,16 +2787,16 @@ "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaCustomAttribute" }, - "description": "Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is ` traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.", + "description": "Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.", "type": "object" }, "attributionToken": { - "description": "Token to attribute an API response to user action(s) to trigger the event. Highly recommended for user events that are the result of RecommendationService.Recommend. This field enables accurate attribution of recommendation model performance. The value must be one of: * PredictResponse.attribution_token for events that are the result of RecommendationService.Recommend. * SearchResponse.attribution_token for events that are the result of SearchService.Search. * CompleteQueryResponse.attribution_token for events that are the result of CompletionService.CompleteQuery. This token enables us to accurately attribute page view or conversion completion back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass PredictResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the PredictResponse.attribution_token to this field.", + "description": "Token to attribute an API response to user action(s) to trigger the event. Highly recommended for user events that are the result of RecommendationService.Recommend. This field enables accurate attribution of recommendation model performance. The value must be one of: * RecommendResponse.attribution_token for events that are the result of RecommendationService.Recommend. * SearchResponse.attribution_token for events that are the result of SearchService.Search. This token enables us to accurately attribute page view or conversion completion back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass RecommendResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the RecommendResponse.attribution_token to this field.", "type": "string" }, "completionInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaCompletionInfo", - "description": "CompleteQuery API details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search." + "description": "CompletionService.CompleteQuery details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search." }, "directUserRequest": { "description": "Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.", @@ -2819,7 +2819,7 @@ "type": "string" }, "filter": { - "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendationService.RecommendRequest, this field may be populated directly from RecommendationService.RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendationService.RecommendRequest, this field may be populated directly from RecommendationService.RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" }, "mediaInfo": { @@ -2843,7 +2843,7 @@ }, "searchInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchInfo", - "description": "Search API details related to the event. This field should be set for `search` event." + "description": "SearchService.Search details related to the event. This field should be set for `search` event." }, "sessionId": { "description": "A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix.", @@ -2865,7 +2865,7 @@ "description": "Information about the end user." }, "userPseudoId": { - "description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not 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. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field.", + "description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not 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. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field.", "type": "string" } }, @@ -2876,7 +2876,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaUserInfo", "properties": { "userAgent": { - "description": "User agent as included in the HTTP header. Required for getting SearchResponse.sponsored_results. 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.", + "description": "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.", "type": "string" }, "userId": { @@ -2887,7 +2887,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata": { - "description": "Metadata related to the progress of the ImportDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata", "properties": { "createTime": { @@ -2936,14 +2936,14 @@ "id": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", "properties": { "gcsPrefix": { - "description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", + "description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata": { - "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata", "properties": { "createTime": { diff --git a/discoveryengine/v1alpha/discoveryengine-gen.go b/discoveryengine/v1alpha/discoveryengine-gen.go index 21eee7cf7fb..fa65bbc05fa 100644 --- a/discoveryengine/v1alpha/discoveryengine-gen.go +++ b/discoveryengine/v1alpha/discoveryengine-gen.go @@ -770,8 +770,8 @@ func (s *GoogleCloudDiscoveryengineLoggingSourceLocation) MarshalJSON() ([]byte, } // GoogleCloudDiscoveryengineV1ImportDocumentsMetadata: Metadata related -// to the progress of the ImportDocuments operation. This will be -// returned by the google.longrunning.Operation.metadata field. +// to the progress of the ImportDocuments operation. This is returned by +// the google.longrunning.Operation.metadata field. type GoogleCloudDiscoveryengineV1ImportDocumentsMetadata struct { // CreateTime: Operation create time. CreateTime string `json:"createTime,omitempty"` @@ -851,9 +851,9 @@ func (s *GoogleCloudDiscoveryengineV1ImportDocumentsResponse) MarshalJSON() ([]b // destination for Import related errors. type GoogleCloudDiscoveryengineV1ImportErrorConfig struct { // GcsPrefix: Cloud Storage prefix for import errors. This must be an - // empty, existing Cloud Storage directory. Import errors will be - // written to sharded files in this directory, one per line, as a - // JSON-encoded `google.rpc.Status` message. + // empty, existing Cloud Storage directory. Import errors are written to + // sharded files in this directory, one per line, as a JSON-encoded + // `google.rpc.Status` message. GcsPrefix string `json:"gcsPrefix,omitempty"` // ForceSendFields is a list of field names (e.g. "GcsPrefix") to @@ -880,8 +880,8 @@ func (s *GoogleCloudDiscoveryengineV1ImportErrorConfig) MarshalJSON() ([]byte, e } // GoogleCloudDiscoveryengineV1ImportUserEventsMetadata: Metadata -// related to the progress of the Import operation. This will be -// returned by the google.longrunning.Operation.metadata field. +// related to the progress of the Import operation. This is returned by +// the google.longrunning.Operation.metadata field. type GoogleCloudDiscoveryengineV1ImportUserEventsMetadata struct { // CreateTime: Operation create time. CreateTime string `json:"createTime,omitempty"` @@ -1121,8 +1121,8 @@ type GoogleCloudDiscoveryengineV1alphaBigQuerySource struct { // `document` (default): One Document format per row. Each document must // have a valid Document.id and one of Document.json_data or // Document.struct_data. * `custom`: One custom data per row in - // arbitrary format that conforms the defined Schema of the data store. - // This can only be used by the GENERIC Data Store vertical. + // arbitrary format that conforms to the defined Schema of the data + // store. This can only be used by the GENERIC Data Store vertical. DataSchema string `json:"dataSchema,omitempty"` // DatasetId: Required. The BigQuery data set to copy the data from with @@ -1176,12 +1176,12 @@ func (s *GoogleCloudDiscoveryengineV1alphaBigQuerySource) MarshalJSON() ([]byte, // completion info. type GoogleCloudDiscoveryengineV1alphaCompletionInfo struct { // SelectedPosition: End user selected - // CompleteQueryResponse.CompletionResult.suggestion position, starting + // CompleteQueryResponse.QuerySuggestion.suggestion position, starting // from 0. SelectedPosition int64 `json:"selectedPosition,omitempty"` // SelectedSuggestion: End user selected - // CompleteQueryResponse.CompletionResult.suggestion. + // CompleteQueryResponse.QuerySuggestion.suggestion. SelectedSuggestion string `json:"selectedSuggestion,omitempty"` // ForceSendFields is a list of field names (e.g. "SelectedPosition") to @@ -1273,8 +1273,8 @@ type GoogleCloudDiscoveryengineV1alphaDocument struct { Id string `json:"id,omitempty"` // JsonData: The JSON string representation of the document. It should - // conform to the registered Schema.schema or an `INVALID_ARGUMENT` - // error is thrown. + // conform to the registered Schema or an `INVALID_ARGUMENT` error is + // thrown. JsonData string `json:"jsonData,omitempty"` // Name: Immutable. The full resource name of the document. Format: @@ -1295,8 +1295,8 @@ type GoogleCloudDiscoveryengineV1alphaDocument struct { SchemaId string `json:"schemaId,omitempty"` // StructData: The structured JSON data for the document. It should - // conform to the registered Schema.schema or an `INVALID_ARGUMENT` - // error is thrown. + // conform to the registered Schema or an `INVALID_ARGUMENT` error is + // thrown. StructData googleapi.RawMessage `json:"structData,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -1348,8 +1348,7 @@ type GoogleCloudDiscoveryengineV1alphaDocumentInfo struct { // events of the following event types: * `add-to-cart` * `purchase` Quantity int64 `json:"quantity,omitempty"` - // Uri: The Document url - only allowed for DataStores with - // content_config PUBLIC_WEBSITE. + // Uri: The Document URI - only allowed for website data stores. Uri string `json:"uri,omitempty"` // ForceSendFields is a list of field names (e.g. "Id") to @@ -1382,15 +1381,14 @@ type GoogleCloudDiscoveryengineV1alphaGcsSource struct { // Supported values for document imports: * `document` (default): One // JSON Document per line. Each document must have a valid Document.id. // * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by - // `input_uris` will become a document, with the ID set to the first 128 + // `input_uris` becomes a document, with the ID set to the first 128 // bits of SHA256(URI) encoded as a hex string. * `custom`: One custom - // data JSON per row in arbitrary format that conforms the defined - // Schema of the data store. This can only be used by the GENERIC Data - // Store vertical. * `csv`: A CSV file with header conforming the - // defined Schema of the data store. Each entry after the header will be - // imported as a Document. This can only be used by the GENERIC Data - // Store vertical. Supported values for user even imports: * - // `user_event` (default): One JSON UserEvent per line. + // data JSON per row in arbitrary format that conforms to the defined + // Schema of the data store. This can only be used by Gen App Builder. * + // `csv`: A CSV file with header conforming to the defined Schema of the + // data store. Each entry after the header is imported as a Document. + // This can only be used by Gen App Builder. Supported values for user + // even imports: * `user_event` (default): One JSON UserEvent per line. DataSchema string `json:"dataSchema,omitempty"` // InputUris: Required. Cloud Storage URIs to input files. URI can be up @@ -1426,8 +1424,8 @@ func (s *GoogleCloudDiscoveryengineV1alphaGcsSource) MarshalJSON() ([]byte, erro } // GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata: Metadata -// related to the progress of the ImportDocuments operation. This will -// be returned by the google.longrunning.Operation.metadata field. +// related to the progress of the ImportDocuments operation. This is +// returned by the google.longrunning.Operation.metadata field. type GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata struct { // CreateTime: Operation create time. CreateTime string `json:"createTime,omitempty"` @@ -1475,11 +1473,10 @@ type GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest struct { // consistent during multiple imports. In which case // ReconciliationMode.FULL is highly recommended to avoid duplicate // contents. If unset or set to `false`, Document.ids have to be - // specified using id_field, otherwises, documents without IDs will fail - // to be imported. Only set this field when using GcsSource or - // BigQuerySource, and when GcsSource.data_schema or - // BigQuerySource.data_schema is `custom` or `csv`. Otherwise, an - // INVALID_ARGUMENT error is thrown. + // specified using id_field, otherwise, documents without IDs fail to be + // imported. Only set this field when using GcsSource or BigQuerySource, + // and when GcsSource.data_schema or BigQuerySource.data_schema is + // `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. AutoGenerateIds bool `json:"autoGenerateIds,omitempty"` // BigquerySource: BigQuery input source. @@ -1497,12 +1494,12 @@ type GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest struct { // key of the JSON field. For instance, `my_id` for JSON `{"my_id": // "some_uuid"}`. For BigQuerySource it is the column name of the // BigQuery table where the unique ids are stored. The values of the - // JSON field or the BigQuery column will be used as the Document.ids. - // The JSON field or the BigQuery column must be of string type, and the + // JSON field or the BigQuery column are used as the Document.ids. The + // JSON field or the BigQuery column must be of string type, and the // values must be set as valid strings conform to RFC-1034 // (https://tools.ietf.org/html/rfc1034) with 1-63 characters. - // Otherwise, documents without valid IDs will fail to be imported. Only - // set this field when using GcsSource or BigQuerySource, and when + // Otherwise, documents without valid IDs fail to be imported. Only set + // this field when using GcsSource or BigQuerySource, and when // GcsSource.data_schema or BigQuerySource.data_schema is `custom`. And // only set this field when auto_generate_ids is unset or set as // `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is @@ -1621,9 +1618,9 @@ func (s *GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse) MarshalJSON() // destination for Import related errors. type GoogleCloudDiscoveryengineV1alphaImportErrorConfig struct { // GcsPrefix: Cloud Storage prefix for import errors. This must be an - // empty, existing Cloud Storage directory. Import errors will be - // written to sharded files in this directory, one per line, as a - // JSON-encoded `google.rpc.Status` message. + // empty, existing Cloud Storage directory. Import errors are written to + // sharded files in this directory, one per line, as a JSON-encoded + // `google.rpc.Status` message. GcsPrefix string `json:"gcsPrefix,omitempty"` // ForceSendFields is a list of field names (e.g. "GcsPrefix") to @@ -1650,8 +1647,8 @@ func (s *GoogleCloudDiscoveryengineV1alphaImportErrorConfig) MarshalJSON() ([]by } // GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata: Metadata -// related to the progress of the Import operation. This will be -// returned by the google.longrunning.Operation.metadata field. +// related to the progress of the Import operation. This is returned by +// the google.longrunning.Operation.metadata field. type GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata struct { // CreateTime: Operation create time. CreateTime string `json:"createTime,omitempty"` @@ -1905,16 +1902,16 @@ type GoogleCloudDiscoveryengineV1alphaPageInfo struct { // different hierarchies. If '>' is part of the category name, please // replace it with other character(s). Category pages include special // pages such as sales or promotions. For instance, a special sale page - // may have the category hierarchy: "pageCategory" : "Sales > 2017 Black - // Friday Deals". Required for `view-category-page` events. Other event - // types should not set this field. Otherwise, an INVALID_ARGUMENT error - // is returned. + // may have the category hierarchy: "pageCategory" : "Sales > 2017 + // Black Friday Deals". Required for `view-category-page` events. Other + // event types should not set this field. Otherwise, an + // `INVALID_ARGUMENT` error is returned. PageCategory string `json:"pageCategory,omitempty"` // PageviewId: A unique ID of a web page view. This should be kept the // same for all user events triggered from the same pageview. For // example, an item detail page view could trigger multiple events as - // the user is browsing the page. The `pageViewId` property should be + // the user is browsing the page. The `pageview_id` property should be // kept the same for all these events so that they can be grouped // together properly. When using the client side event reporting with // JavaScript pixel and Google Tag Manager, this value is filled in @@ -2457,25 +2454,25 @@ type GoogleCloudDiscoveryengineV1alphaSearchInfo struct { // Offset: An integer that specifies the current offset for pagination // (the 0-indexed starting location, amongst the products deemed by the // API as relevant). See SearchRequest.offset for definition. If this - // field is negative, an INVALID_ARGUMENT is returned. This can only be - // set for `search` events. Other event types should not set this field. - // Otherwise, an INVALID_ARGUMENT error is returned. + // field is negative, an `INVALID_ARGUMENT` is returned. This can only + // be set for `search` events. Other event types should not set this + // field. Otherwise, an `INVALID_ARGUMENT` error is returned. Offset int64 `json:"offset,omitempty"` // OrderBy: The order in which products are returned, if applicable. See // SearchRequest.order_by for definition and syntax. The value must be a // UTF-8 encoded string with a length limit of 1,000 characters. - // Otherwise, an INVALID_ARGUMENT error is returned. This can only be + // Otherwise, an `INVALID_ARGUMENT` error is returned. This can only be // set for `search` events. Other event types should not set this field. - // Otherwise, an INVALID_ARGUMENT error is returned. + // Otherwise, an `INVALID_ARGUMENT` error is returned. OrderBy string `json:"orderBy,omitempty"` // SearchQuery: The user's search query. See SearchRequest.query for // definition. The value must be a UTF-8 encoded string with a length - // limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is + // limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is // returned. At least one of search_query or PageInfo.page_category is // required for `search` events. Other event types should not set this - // field. Otherwise, an INVALID_ARGUMENT error is returned. + // field. Otherwise, an `INVALID_ARGUMENT` error is returned. SearchQuery string `json:"searchQuery,omitempty"` // ForceSendFields is a list of field names (e.g. "Offset") to @@ -2504,13 +2501,13 @@ func (s *GoogleCloudDiscoveryengineV1alphaSearchInfo) MarshalJSON() ([]byte, err // GoogleCloudDiscoveryengineV1alphaTargetSite: A target site for the // SiteSearchEngine. type GoogleCloudDiscoveryengineV1alphaTargetSite struct { - // ExactMatch: Input only. If set to false, an uri_pattern will be - // generated to include all pages whose address contains the - // provided_uri_pattern. If set to true, an uri_pattern will be - // generated to try to be an exact match of the provided_uri_pattern or - // just the specific page if the provided_uri_pattern is a specific one. - // provided_uri_pattern will always be normalized to generate the uri - // pattern to be used by the search engine. + // ExactMatch: Input only. If set to false, a uri_pattern is generated + // to include all pages whose address contains the provided_uri_pattern. + // If set to true, an uri_pattern is generated to try to be an exact + // match of the provided_uri_pattern or just the specific page if the + // provided_uri_pattern is a specific one. provided_uri_pattern is + // always normalized to generate the URI pattern to be used by the + // search engine. ExactMatch bool `json:"exactMatch,omitempty"` // GeneratedUriPattern: Output only. This is system-generated based on @@ -2524,7 +2521,7 @@ type GoogleCloudDiscoveryengineV1alphaTargetSite struct { // `target_site_id` is system-generated. Name string `json:"name,omitempty"` - // ProvidedUriPattern: Required. Input only. The user provided uri + // ProvidedUriPattern: Required. Input only. The user provided URI // pattern from which the `generated_uri_pattern` is generated. ProvidedUriPattern string `json:"providedUriPattern,omitempty"` @@ -2661,7 +2658,7 @@ type GoogleCloudDiscoveryengineV1alphaUserEvent struct { // allowed. Each value must be a UTF-8 encoded string with a length // limit of 256 characters. * For number attributes, at most 400 values // are allowed. For product recommendations, an example of extra user - // information is ` traffic_channel`, which is how a user arrives at the + // information is `traffic_channel`, which is how a user arrives at the // site. Users can arrive at the site by coming to the site directly, // coming through Google search, or in other ways. Attributes map[string]GoogleCloudDiscoveryengineV1alphaCustomAttribute `json:"attributes,omitempty"` @@ -2670,23 +2667,22 @@ type GoogleCloudDiscoveryengineV1alphaUserEvent struct { // action(s) to trigger the event. Highly recommended for user events // that are the result of RecommendationService.Recommend. This field // enables accurate attribution of recommendation model performance. The - // value must be one of: * PredictResponse.attribution_token for events - // that are the result of RecommendationService.Recommend. * + // value must be one of: * RecommendResponse.attribution_token for + // events that are the result of RecommendationService.Recommend. * // SearchResponse.attribution_token for events that are the result of - // SearchService.Search. * CompleteQueryResponse.attribution_token for - // events that are the result of CompletionService.CompleteQuery. This - // token enables us to accurately attribute page view or conversion - // completion back to the event and the particular predict response - // containing this clicked/purchased product. If user clicks on product - // K in the recommendation results, pass - // PredictResponse.attribution_token as a URL parameter to product K's - // page. When recording events on product K's page, log the - // PredictResponse.attribution_token to this field. + // SearchService.Search. This token enables us to accurately attribute + // page view or conversion completion back to the event and the + // particular predict response containing this clicked/purchased + // product. If user clicks on product K in the recommendation results, + // pass RecommendResponse.attribution_token as a URL parameter to + // product K's page. When recording events on product K's page, log the + // RecommendResponse.attribution_token to this field. AttributionToken string `json:"attributionToken,omitempty"` - // CompletionInfo: CompleteQuery API details related to the event. This - // field should be set for `search` event when autocomplete function is - // enabled and the user clicks a suggestion for search. + // CompletionInfo: CompletionService.CompleteQuery details related to + // the event. This field should be set for `search` event when + // autocomplete function is enabled and the user clicks a suggestion for + // search. CompletionInfo *GoogleCloudDiscoveryengineV1alphaCompletionInfo `json:"completionInfo,omitempty"` // DirectUserRequest: Should set to true if the request is made directly @@ -2734,7 +2730,7 @@ type GoogleCloudDiscoveryengineV1alphaUserEvent struct { // directly from RecommendationService.RecommendRequest.filter // conforming to https://google.aip.dev/160#filtering. The value must be // a UTF-8 encoded string with a length limit of 1,000 characters. - // Otherwise, an INVALID_ARGUMENT error is returned. + // Otherwise, an `INVALID_ARGUMENT` error is returned. Filter string `json:"filter,omitempty"` // MediaInfo: Media-specific info. @@ -2751,8 +2747,8 @@ type GoogleCloudDiscoveryengineV1alphaUserEvent struct { // promotions. Currently, this field is restricted to at most one ID. PromotionIds []string `json:"promotionIds,omitempty"` - // SearchInfo: Search API details related to the event. This field - // should be set for `search` event. + // SearchInfo: SearchService.Search details related to the event. This + // field should be set for `search` event. SearchInfo *GoogleCloudDiscoveryengineV1alphaSearchInfo `json:"searchInfo,omitempty"` // SessionId: A unique identifier for tracking a visitor session with a @@ -2784,8 +2780,8 @@ type GoogleCloudDiscoveryengineV1alphaUserEvent struct { // 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. The field should not contain PII - // or user-data. We recommend to use Google Analytics Client ID + // `INVALID_ARGUMENT` error is returned. The field should not contain + // PII or user-data. We recommend to use Google Analytics Client ID // (https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) // for this field. UserPseudoId string `json:"userPseudoId,omitempty"` @@ -2820,13 +2816,12 @@ func (s *GoogleCloudDiscoveryengineV1alphaUserEvent) MarshalJSON() ([]byte, erro // GoogleCloudDiscoveryengineV1alphaUserInfo: Information of an end // user. type GoogleCloudDiscoveryengineV1alphaUserInfo struct { - // UserAgent: User agent as included in the HTTP header. Required for - // getting SearchResponse.sponsored_results. 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. + // UserAgent: 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. UserAgent string `json:"userAgent,omitempty"` // UserId: Highly recommended for logged-in users. Unique identifier for @@ -2862,8 +2857,8 @@ func (s *GoogleCloudDiscoveryengineV1alphaUserInfo) MarshalJSON() ([]byte, error } // GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata: Metadata -// related to the progress of the ImportDocuments operation. This will -// be returned by the google.longrunning.Operation.metadata field. +// related to the progress of the ImportDocuments operation. This is +// returned by the google.longrunning.Operation.metadata field. type GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata struct { // CreateTime: Operation create time. CreateTime string `json:"createTime,omitempty"` @@ -2943,9 +2938,9 @@ func (s *GoogleCloudDiscoveryengineV1betaImportDocumentsResponse) MarshalJSON() // destination for Import related errors. type GoogleCloudDiscoveryengineV1betaImportErrorConfig struct { // GcsPrefix: Cloud Storage prefix for import errors. This must be an - // empty, existing Cloud Storage directory. Import errors will be - // written to sharded files in this directory, one per line, as a - // JSON-encoded `google.rpc.Status` message. + // empty, existing Cloud Storage directory. Import errors are written to + // sharded files in this directory, one per line, as a JSON-encoded + // `google.rpc.Status` message. GcsPrefix string `json:"gcsPrefix,omitempty"` // ForceSendFields is a list of field names (e.g. "GcsPrefix") to @@ -2972,8 +2967,8 @@ func (s *GoogleCloudDiscoveryengineV1betaImportErrorConfig) MarshalJSON() ([]byt } // GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata: Metadata -// related to the progress of the Import operation. This will be -// returned by the google.longrunning.Operation.metadata field. +// related to the progress of the Import operation. This is returned by +// the google.longrunning.Operation.metadata field. type GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata struct { // CreateTime: Operation create time. CreateTime string `json:"createTime,omitempty"` @@ -3997,7 +3992,7 @@ type ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall struct { // `projects/{project}/locations/{location}/collections/{collection}/da // taStores/{data_store}/branches/{branch}`. Use `default_branch` as // the branch ID, to list documents under the default branch. If the -// caller does not have permission to list Documentss under this +// caller does not have permission to list Documents under this // branch, regardless of whether or not this branch exists, a // `PERMISSION_DENIED` error is returned. func (r *ProjectsLocationsCollectionsDataStoresBranchesDocumentsService) List(parent string) *ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall { @@ -4148,7 +4143,7 @@ func (c *ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall) Do(opt // "type": "string" // }, // "parent": { - // "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", + // "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", // "required": true, @@ -6077,7 +6072,7 @@ type ProjectsLocationsCollectionsDataStoresUserEventsCollectCall struct { } // Collect: Writes a single user event from the browser. This uses a GET -// request to due to browser restriction of POST-ing to a 3rd party +// request to due to browser restriction of POST-ing to a third-party // domain. This method is used only by the Discovery Engine API // JavaScript pixel and Google Tag Manager. Users should not call this // method directly. @@ -6102,7 +6097,7 @@ func (c *ProjectsLocationsCollectionsDataStoresUserEventsCollectCall) Ets(ets in // Uri sets the optional parameter "uri": The URL including // cgi-parameters but excluding the hash fragment with a length limit of // 5,000 characters. This is often more useful than the referer URL, -// because many browsers only send the domain for 3rd party requests. +// because many browsers only send the domain for third-party requests. func (c *ProjectsLocationsCollectionsDataStoresUserEventsCollectCall) Uri(uri string) *ProjectsLocationsCollectionsDataStoresUserEventsCollectCall { c.urlParams_.Set("uri", uri) return c @@ -6214,7 +6209,7 @@ func (c *ProjectsLocationsCollectionsDataStoresUserEventsCollectCall) Do(opts .. } return ret, nil // { - // "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", + // "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", // "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:collect", // "httpMethod": "GET", // "id": "discoveryengine.projects.locations.collections.dataStores.userEvents.collect", @@ -6236,7 +6231,7 @@ func (c *ProjectsLocationsCollectionsDataStoresUserEventsCollectCall) Do(opts .. // "type": "string" // }, // "uri": { - // "description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.", + // "description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", // "location": "query", // "type": "string" // }, @@ -8032,7 +8027,7 @@ type ProjectsLocationsDataStoresBranchesDocumentsListCall struct { // `projects/{project}/locations/{location}/collections/{collection}/da // taStores/{data_store}/branches/{branch}`. Use `default_branch` as // the branch ID, to list documents under the default branch. If the -// caller does not have permission to list Documentss under this +// caller does not have permission to list Documents under this // branch, regardless of whether or not this branch exists, a // `PERMISSION_DENIED` error is returned. func (r *ProjectsLocationsDataStoresBranchesDocumentsService) List(parent string) *ProjectsLocationsDataStoresBranchesDocumentsListCall { @@ -8183,7 +8178,7 @@ func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) Do(opts ...google // "type": "string" // }, // "parent": { - // "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", + // "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", // "required": true, @@ -9757,7 +9752,7 @@ type ProjectsLocationsDataStoresUserEventsCollectCall struct { } // Collect: Writes a single user event from the browser. This uses a GET -// request to due to browser restriction of POST-ing to a 3rd party +// request to due to browser restriction of POST-ing to a third-party // domain. This method is used only by the Discovery Engine API // JavaScript pixel and Google Tag Manager. Users should not call this // method directly. @@ -9782,7 +9777,7 @@ func (c *ProjectsLocationsDataStoresUserEventsCollectCall) Ets(ets int64) *Proje // Uri sets the optional parameter "uri": The URL including // cgi-parameters but excluding the hash fragment with a length limit of // 5,000 characters. This is often more useful than the referer URL, -// because many browsers only send the domain for 3rd party requests. +// because many browsers only send the domain for third-party requests. func (c *ProjectsLocationsDataStoresUserEventsCollectCall) Uri(uri string) *ProjectsLocationsDataStoresUserEventsCollectCall { c.urlParams_.Set("uri", uri) return c @@ -9894,7 +9889,7 @@ func (c *ProjectsLocationsDataStoresUserEventsCollectCall) Do(opts ...googleapi. } return ret, nil // { - // "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", + // "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", // "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:collect", // "httpMethod": "GET", // "id": "discoveryengine.projects.locations.dataStores.userEvents.collect", @@ -9916,7 +9911,7 @@ func (c *ProjectsLocationsDataStoresUserEventsCollectCall) Do(opts ...googleapi. // "type": "string" // }, // "uri": { - // "description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.", + // "description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", // "location": "query", // "type": "string" // }, diff --git a/discoveryengine/v1beta/discoveryengine-api.json b/discoveryengine/v1beta/discoveryengine-api.json index 991b160c2e2..c592bfb2b7b 100644 --- a/discoveryengine/v1beta/discoveryengine-api.json +++ b/discoveryengine/v1beta/discoveryengine-api.json @@ -249,7 +249,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", + "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", "required": true, @@ -652,7 +652,7 @@ "userEvents": { "methods": { "collect": { - "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", + "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:collect", "httpMethod": "GET", "id": "discoveryengine.projects.locations.collections.dataStores.userEvents.collect", @@ -674,7 +674,7 @@ "type": "string" }, "uri": { - "description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.", + "description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", "location": "query", "type": "string" }, @@ -1036,7 +1036,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", + "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", "required": true, @@ -1365,7 +1365,7 @@ "userEvents": { "methods": { "collect": { - "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", + "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:collect", "httpMethod": "GET", "id": "discoveryengine.projects.locations.dataStores.userEvents.collect", @@ -1387,7 +1387,7 @@ "type": "string" }, "uri": { - "description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.", + "description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", "location": "query", "type": "string" }, @@ -1610,7 +1610,7 @@ } } }, - "revision": "20230620", + "revision": "20230623", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -1760,7 +1760,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata": { - "description": "Metadata related to the progress of the ImportDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata", "properties": { "createTime": { @@ -1809,14 +1809,14 @@ "id": "GoogleCloudDiscoveryengineV1ImportErrorConfig", "properties": { "gcsPrefix": { - "description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", + "description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata": { - "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata", "properties": { "createTime": { @@ -1954,7 +1954,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": { - "description": "Metadata related to the progress of the ImportDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata", "properties": { "createTime": { @@ -2003,14 +2003,14 @@ "id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", "properties": { "gcsPrefix": { - "description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", + "description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": { - "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata", "properties": { "createTime": { @@ -2177,7 +2177,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaTargetSite", "properties": { "exactMatch": { - "description": "Input only. If set to false, an uri_pattern will be generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern will be generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern will always be normalized to generate the uri pattern to be used by the search engine.", + "description": "Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.", "type": "boolean" }, "generatedUriPattern": { @@ -2191,7 +2191,7 @@ "type": "string" }, "providedUriPattern": { - "description": "Required. Input only. The user provided uri pattern from which the `generated_uri_pattern` is generated.", + "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", "type": "string" }, "type": { @@ -2222,7 +2222,7 @@ "id": "GoogleCloudDiscoveryengineV1betaBigQuerySource", "properties": { "dataSchema": { - "description": "The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.", + "description": "The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.", "type": "string" }, "datasetId": { @@ -2253,12 +2253,12 @@ "id": "GoogleCloudDiscoveryengineV1betaCompletionInfo", "properties": { "selectedPosition": { - "description": "End user selected CompleteQueryResponse.CompletionResult.suggestion position, starting from 0.", + "description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0.", "format": "int32", "type": "integer" }, "selectedSuggestion": { - "description": "End user selected CompleteQueryResponse.CompletionResult.suggestion.", + "description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion.", "type": "string" } }, @@ -2295,7 +2295,7 @@ "type": "string" }, "jsonData": { - "description": "The JSON string representation of the document. It should conform to the registered Schema.schema or an `INVALID_ARGUMENT` error is thrown.", + "description": "The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.", "type": "string" }, "name": { @@ -2315,7 +2315,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "The structured JSON data for the document. It should conform to the registered Schema.schema or an `INVALID_ARGUMENT` error is thrown.", + "description": "The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.", "type": "object" } }, @@ -2346,7 +2346,7 @@ "type": "integer" }, "uri": { - "description": "The Document url - only allowed for DataStores with content_config PUBLIC_WEBSITE.", + "description": "The Document URI - only allowed for website data stores.", "type": "string" } }, @@ -2357,7 +2357,7 @@ "id": "GoogleCloudDiscoveryengineV1betaGcsSource", "properties": { "dataSchema": { - "description": "The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` will become a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming the defined Schema of the data store. Each entry after the header will be imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.", + "description": "The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.", "type": "string" }, "inputUris": { @@ -2371,7 +2371,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata": { - "description": "Metadata related to the progress of the ImportDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata", "properties": { "createTime": { @@ -2402,7 +2402,7 @@ "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsRequest", "properties": { "autoGenerateIds": { - "description": "Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwises, documents without IDs will fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.", + "description": "Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.", "type": "boolean" }, "bigquerySource": { @@ -2418,7 +2418,7 @@ "description": "Cloud Storage location for the input content." }, "idField": { - "description": "The field in the Cloud Storage and BigQuery sources that indicates the unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{\"my_id\": \"some_uuid\"}`. For BigQuerySource it is the column name of the BigQuery table where the unique ids are stored. The values of the JSON field or the BigQuery column will be used as the Document.ids. The JSON field or the BigQuery column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs will fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is `custom`. And only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources.", + "description": "The field in the Cloud Storage and BigQuery sources that indicates the unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{\"my_id\": \"some_uuid\"}`. For BigQuerySource it is the column name of the BigQuery table where the unique ids are stored. The values of the JSON field or the BigQuery column are used as the Document.ids. The JSON field or the BigQuery column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is `custom`. And only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources.", "type": "string" }, "inlineSource": { @@ -2479,14 +2479,14 @@ "id": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", "properties": { "gcsPrefix": { - "description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors will be written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", + "description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", "type": "string" } }, "type": "object" }, "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata": { - "description": "Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.", + "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata", "properties": { "createTime": { @@ -2617,11 +2617,11 @@ "id": "GoogleCloudDiscoveryengineV1betaPageInfo", "properties": { "pageCategory": { - "description": "The most specific category associated with a category page. To represent full path of category, use '\u003e' sign to separate different hierarchies. If '\u003e' is part of the category name, please replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: \"pageCategory\" : \"Sales \u003e 2017 Black Friday Deals\". Required for `view-category-page` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "The most specific category associated with a category page. To represent full path of category, use '\u003e' sign to separate different hierarchies. If '\u003e' is part of the category name, please replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `\"pageCategory\" : \"Sales \u003e 2017 Black Friday Deals\"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" }, "pageviewId": { - "description": "A unique ID of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The `pageViewId` property should be kept the same for all these events so that they can be grouped together properly. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.", + "description": "A unique ID of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The `pageview_id` property should be kept the same for all these events so that they can be grouped together properly. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.", "type": "string" }, "referrerUri": { @@ -2838,16 +2838,16 @@ "id": "GoogleCloudDiscoveryengineV1betaSearchInfo", "properties": { "offset": { - "description": "An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant). See SearchRequest.offset for definition. If this field is negative, an INVALID_ARGUMENT is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant). See SearchRequest.offset for definition. If this field is negative, an `INVALID_ARGUMENT` is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.", "format": "int32", "type": "integer" }, "orderBy": { - "description": "The order in which products are returned, if applicable. See SearchRequest.order_by for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "The order in which products are returned, if applicable. See SearchRequest.order_by for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This can only be set for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" }, "searchQuery": { - "description": "The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, @@ -2896,16 +2896,16 @@ "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1betaCustomAttribute" }, - "description": "Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is ` traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.", + "description": "Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.", "type": "object" }, "attributionToken": { - "description": "Token to attribute an API response to user action(s) to trigger the event. Highly recommended for user events that are the result of RecommendationService.Recommend. This field enables accurate attribution of recommendation model performance. The value must be one of: * PredictResponse.attribution_token for events that are the result of RecommendationService.Recommend. * SearchResponse.attribution_token for events that are the result of SearchService.Search. * CompleteQueryResponse.attribution_token for events that are the result of CompletionService.CompleteQuery. This token enables us to accurately attribute page view or conversion completion back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass PredictResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the PredictResponse.attribution_token to this field.", + "description": "Token to attribute an API response to user action(s) to trigger the event. Highly recommended for user events that are the result of RecommendationService.Recommend. This field enables accurate attribution of recommendation model performance. The value must be one of: * RecommendResponse.attribution_token for events that are the result of RecommendationService.Recommend. * SearchResponse.attribution_token for events that are the result of SearchService.Search. This token enables us to accurately attribute page view or conversion completion back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass RecommendResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the RecommendResponse.attribution_token to this field.", "type": "string" }, "completionInfo": { "$ref": "GoogleCloudDiscoveryengineV1betaCompletionInfo", - "description": "CompleteQuery API details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search." + "description": "CompletionService.CompleteQuery details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search." }, "directUserRequest": { "description": "Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.", @@ -2928,7 +2928,7 @@ "type": "string" }, "filter": { - "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendationService.RecommendRequest, this field may be populated directly from RecommendationService.RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendationService.RecommendRequest, this field may be populated directly from RecommendationService.RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" }, "mediaInfo": { @@ -2952,7 +2952,7 @@ }, "searchInfo": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchInfo", - "description": "Search API details related to the event. This field should be set for `search` event." + "description": "SearchService.Search details related to the event. This field should be set for `search` event." }, "sessionId": { "description": "A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix.", @@ -2974,7 +2974,7 @@ "description": "Information about the end user." }, "userPseudoId": { - "description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not 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. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field.", + "description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Do not 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. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field.", "type": "string" } }, @@ -2985,7 +2985,7 @@ "id": "GoogleCloudDiscoveryengineV1betaUserInfo", "properties": { "userAgent": { - "description": "User agent as included in the HTTP header. Required for getting SearchResponse.sponsored_results. 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.", + "description": "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.", "type": "string" }, "userId": { diff --git a/discoveryengine/v1beta/discoveryengine-gen.go b/discoveryengine/v1beta/discoveryengine-gen.go index 2158962a057..b00344d464e 100644 --- a/discoveryengine/v1beta/discoveryengine-gen.go +++ b/discoveryengine/v1beta/discoveryengine-gen.go @@ -770,8 +770,8 @@ func (s *GoogleCloudDiscoveryengineLoggingSourceLocation) MarshalJSON() ([]byte, } // GoogleCloudDiscoveryengineV1ImportDocumentsMetadata: Metadata related -// to the progress of the ImportDocuments operation. This will be -// returned by the google.longrunning.Operation.metadata field. +// to the progress of the ImportDocuments operation. This is returned by +// the google.longrunning.Operation.metadata field. type GoogleCloudDiscoveryengineV1ImportDocumentsMetadata struct { // CreateTime: Operation create time. CreateTime string `json:"createTime,omitempty"` @@ -851,9 +851,9 @@ func (s *GoogleCloudDiscoveryengineV1ImportDocumentsResponse) MarshalJSON() ([]b // destination for Import related errors. type GoogleCloudDiscoveryengineV1ImportErrorConfig struct { // GcsPrefix: Cloud Storage prefix for import errors. This must be an - // empty, existing Cloud Storage directory. Import errors will be - // written to sharded files in this directory, one per line, as a - // JSON-encoded `google.rpc.Status` message. + // empty, existing Cloud Storage directory. Import errors are written to + // sharded files in this directory, one per line, as a JSON-encoded + // `google.rpc.Status` message. GcsPrefix string `json:"gcsPrefix,omitempty"` // ForceSendFields is a list of field names (e.g. "GcsPrefix") to @@ -880,8 +880,8 @@ func (s *GoogleCloudDiscoveryengineV1ImportErrorConfig) MarshalJSON() ([]byte, e } // GoogleCloudDiscoveryengineV1ImportUserEventsMetadata: Metadata -// related to the progress of the Import operation. This will be -// returned by the google.longrunning.Operation.metadata field. +// related to the progress of the Import operation. This is returned by +// the google.longrunning.Operation.metadata field. type GoogleCloudDiscoveryengineV1ImportUserEventsMetadata struct { // CreateTime: Operation create time. CreateTime string `json:"createTime,omitempty"` @@ -1113,8 +1113,8 @@ func (s *GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse) Marsha } // GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata: Metadata -// related to the progress of the ImportDocuments operation. This will -// be returned by the google.longrunning.Operation.metadata field. +// related to the progress of the ImportDocuments operation. This is +// returned by the google.longrunning.Operation.metadata field. type GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata struct { // CreateTime: Operation create time. CreateTime string `json:"createTime,omitempty"` @@ -1194,9 +1194,9 @@ func (s *GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse) MarshalJSON() // destination for Import related errors. type GoogleCloudDiscoveryengineV1alphaImportErrorConfig struct { // GcsPrefix: Cloud Storage prefix for import errors. This must be an - // empty, existing Cloud Storage directory. Import errors will be - // written to sharded files in this directory, one per line, as a - // JSON-encoded `google.rpc.Status` message. + // empty, existing Cloud Storage directory. Import errors are written to + // sharded files in this directory, one per line, as a JSON-encoded + // `google.rpc.Status` message. GcsPrefix string `json:"gcsPrefix,omitempty"` // ForceSendFields is a list of field names (e.g. "GcsPrefix") to @@ -1223,8 +1223,8 @@ func (s *GoogleCloudDiscoveryengineV1alphaImportErrorConfig) MarshalJSON() ([]by } // GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata: Metadata -// related to the progress of the Import operation. This will be -// returned by the google.longrunning.Operation.metadata field. +// related to the progress of the Import operation. This is returned by +// the google.longrunning.Operation.metadata field. type GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata struct { // CreateTime: Operation create time. CreateTime string `json:"createTime,omitempty"` @@ -1501,13 +1501,13 @@ func (s *GoogleCloudDiscoveryengineV1alphaSchema) MarshalJSON() ([]byte, error) // GoogleCloudDiscoveryengineV1alphaTargetSite: A target site for the // SiteSearchEngine. type GoogleCloudDiscoveryengineV1alphaTargetSite struct { - // ExactMatch: Input only. If set to false, an uri_pattern will be - // generated to include all pages whose address contains the - // provided_uri_pattern. If set to true, an uri_pattern will be - // generated to try to be an exact match of the provided_uri_pattern or - // just the specific page if the provided_uri_pattern is a specific one. - // provided_uri_pattern will always be normalized to generate the uri - // pattern to be used by the search engine. + // ExactMatch: Input only. If set to false, a uri_pattern is generated + // to include all pages whose address contains the provided_uri_pattern. + // If set to true, an uri_pattern is generated to try to be an exact + // match of the provided_uri_pattern or just the specific page if the + // provided_uri_pattern is a specific one. provided_uri_pattern is + // always normalized to generate the URI pattern to be used by the + // search engine. ExactMatch bool `json:"exactMatch,omitempty"` // GeneratedUriPattern: Output only. This is system-generated based on @@ -1521,7 +1521,7 @@ type GoogleCloudDiscoveryengineV1alphaTargetSite struct { // `target_site_id` is system-generated. Name string `json:"name,omitempty"` - // ProvidedUriPattern: Required. Input only. The user provided uri + // ProvidedUriPattern: Required. Input only. The user provided URI // pattern from which the `generated_uri_pattern` is generated. ProvidedUriPattern string `json:"providedUriPattern,omitempty"` @@ -1570,8 +1570,8 @@ type GoogleCloudDiscoveryengineV1betaBigQuerySource struct { // `document` (default): One Document format per row. Each document must // have a valid Document.id and one of Document.json_data or // Document.struct_data. * `custom`: One custom data per row in - // arbitrary format that conforms the defined Schema of the data store. - // This can only be used by the GENERIC Data Store vertical. + // arbitrary format that conforms to the defined Schema of the data + // store. This can only be used by the GENERIC Data Store vertical. DataSchema string `json:"dataSchema,omitempty"` // DatasetId: Required. The BigQuery data set to copy the data from with @@ -1625,12 +1625,12 @@ func (s *GoogleCloudDiscoveryengineV1betaBigQuerySource) MarshalJSON() ([]byte, // completion info. type GoogleCloudDiscoveryengineV1betaCompletionInfo struct { // SelectedPosition: End user selected - // CompleteQueryResponse.CompletionResult.suggestion position, starting + // CompleteQueryResponse.QuerySuggestion.suggestion position, starting // from 0. SelectedPosition int64 `json:"selectedPosition,omitempty"` // SelectedSuggestion: End user selected - // CompleteQueryResponse.CompletionResult.suggestion. + // CompleteQueryResponse.QuerySuggestion.suggestion. SelectedSuggestion string `json:"selectedSuggestion,omitempty"` // ForceSendFields is a list of field names (e.g. "SelectedPosition") to @@ -1722,8 +1722,8 @@ type GoogleCloudDiscoveryengineV1betaDocument struct { Id string `json:"id,omitempty"` // JsonData: The JSON string representation of the document. It should - // conform to the registered Schema.schema or an `INVALID_ARGUMENT` - // error is thrown. + // conform to the registered Schema or an `INVALID_ARGUMENT` error is + // thrown. JsonData string `json:"jsonData,omitempty"` // Name: Immutable. The full resource name of the document. Format: @@ -1744,8 +1744,8 @@ type GoogleCloudDiscoveryengineV1betaDocument struct { SchemaId string `json:"schemaId,omitempty"` // StructData: The structured JSON data for the document. It should - // conform to the registered Schema.schema or an `INVALID_ARGUMENT` - // error is thrown. + // conform to the registered Schema or an `INVALID_ARGUMENT` error is + // thrown. StructData googleapi.RawMessage `json:"structData,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -1797,8 +1797,7 @@ type GoogleCloudDiscoveryengineV1betaDocumentInfo struct { // events of the following event types: * `add-to-cart` * `purchase` Quantity int64 `json:"quantity,omitempty"` - // Uri: The Document url - only allowed for DataStores with - // content_config PUBLIC_WEBSITE. + // Uri: The Document URI - only allowed for website data stores. Uri string `json:"uri,omitempty"` // ForceSendFields is a list of field names (e.g. "Id") to @@ -1831,15 +1830,14 @@ type GoogleCloudDiscoveryengineV1betaGcsSource struct { // Supported values for document imports: * `document` (default): One // JSON Document per line. Each document must have a valid Document.id. // * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by - // `input_uris` will become a document, with the ID set to the first 128 + // `input_uris` becomes a document, with the ID set to the first 128 // bits of SHA256(URI) encoded as a hex string. * `custom`: One custom - // data JSON per row in arbitrary format that conforms the defined - // Schema of the data store. This can only be used by the GENERIC Data - // Store vertical. * `csv`: A CSV file with header conforming the - // defined Schema of the data store. Each entry after the header will be - // imported as a Document. This can only be used by the GENERIC Data - // Store vertical. Supported values for user even imports: * - // `user_event` (default): One JSON UserEvent per line. + // data JSON per row in arbitrary format that conforms to the defined + // Schema of the data store. This can only be used by Gen App Builder. * + // `csv`: A CSV file with header conforming to the defined Schema of the + // data store. Each entry after the header is imported as a Document. + // This can only be used by Gen App Builder. Supported values for user + // even imports: * `user_event` (default): One JSON UserEvent per line. DataSchema string `json:"dataSchema,omitempty"` // InputUris: Required. Cloud Storage URIs to input files. URI can be up @@ -1875,8 +1873,8 @@ func (s *GoogleCloudDiscoveryengineV1betaGcsSource) MarshalJSON() ([]byte, error } // GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata: Metadata -// related to the progress of the ImportDocuments operation. This will -// be returned by the google.longrunning.Operation.metadata field. +// related to the progress of the ImportDocuments operation. This is +// returned by the google.longrunning.Operation.metadata field. type GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata struct { // CreateTime: Operation create time. CreateTime string `json:"createTime,omitempty"` @@ -1924,11 +1922,10 @@ type GoogleCloudDiscoveryengineV1betaImportDocumentsRequest struct { // consistent during multiple imports. In which case // ReconciliationMode.FULL is highly recommended to avoid duplicate // contents. If unset or set to `false`, Document.ids have to be - // specified using id_field, otherwises, documents without IDs will fail - // to be imported. Only set this field when using GcsSource or - // BigQuerySource, and when GcsSource.data_schema or - // BigQuerySource.data_schema is `custom` or `csv`. Otherwise, an - // INVALID_ARGUMENT error is thrown. + // specified using id_field, otherwise, documents without IDs fail to be + // imported. Only set this field when using GcsSource or BigQuerySource, + // and when GcsSource.data_schema or BigQuerySource.data_schema is + // `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. AutoGenerateIds bool `json:"autoGenerateIds,omitempty"` // BigquerySource: BigQuery input source. @@ -1946,12 +1943,12 @@ type GoogleCloudDiscoveryengineV1betaImportDocumentsRequest struct { // key of the JSON field. For instance, `my_id` for JSON `{"my_id": // "some_uuid"}`. For BigQuerySource it is the column name of the // BigQuery table where the unique ids are stored. The values of the - // JSON field or the BigQuery column will be used as the Document.ids. - // The JSON field or the BigQuery column must be of string type, and the + // JSON field or the BigQuery column are used as the Document.ids. The + // JSON field or the BigQuery column must be of string type, and the // values must be set as valid strings conform to RFC-1034 // (https://tools.ietf.org/html/rfc1034) with 1-63 characters. - // Otherwise, documents without valid IDs will fail to be imported. Only - // set this field when using GcsSource or BigQuerySource, and when + // Otherwise, documents without valid IDs fail to be imported. Only set + // this field when using GcsSource or BigQuerySource, and when // GcsSource.data_schema or BigQuerySource.data_schema is `custom`. And // only set this field when auto_generate_ids is unset or set as // `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is @@ -2070,9 +2067,9 @@ func (s *GoogleCloudDiscoveryengineV1betaImportDocumentsResponse) MarshalJSON() // destination for Import related errors. type GoogleCloudDiscoveryengineV1betaImportErrorConfig struct { // GcsPrefix: Cloud Storage prefix for import errors. This must be an - // empty, existing Cloud Storage directory. Import errors will be - // written to sharded files in this directory, one per line, as a - // JSON-encoded `google.rpc.Status` message. + // empty, existing Cloud Storage directory. Import errors are written to + // sharded files in this directory, one per line, as a JSON-encoded + // `google.rpc.Status` message. GcsPrefix string `json:"gcsPrefix,omitempty"` // ForceSendFields is a list of field names (e.g. "GcsPrefix") to @@ -2099,8 +2096,8 @@ func (s *GoogleCloudDiscoveryengineV1betaImportErrorConfig) MarshalJSON() ([]byt } // GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata: Metadata -// related to the progress of the Import operation. This will be -// returned by the google.longrunning.Operation.metadata field. +// related to the progress of the Import operation. This is returned by +// the google.longrunning.Operation.metadata field. type GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata struct { // CreateTime: Operation create time. CreateTime string `json:"createTime,omitempty"` @@ -2354,16 +2351,16 @@ type GoogleCloudDiscoveryengineV1betaPageInfo struct { // different hierarchies. If '>' is part of the category name, please // replace it with other character(s). Category pages include special // pages such as sales or promotions. For instance, a special sale page - // may have the category hierarchy: "pageCategory" : "Sales > 2017 Black - // Friday Deals". Required for `view-category-page` events. Other event - // types should not set this field. Otherwise, an INVALID_ARGUMENT error - // is returned. + // may have the category hierarchy: "pageCategory" : "Sales > 2017 + // Black Friday Deals". Required for `view-category-page` events. Other + // event types should not set this field. Otherwise, an + // `INVALID_ARGUMENT` error is returned. PageCategory string `json:"pageCategory,omitempty"` // PageviewId: A unique ID of a web page view. This should be kept the // same for all user events triggered from the same pageview. For // example, an item detail page view could trigger multiple events as - // the user is browsing the page. The `pageViewId` property should be + // the user is browsing the page. The `pageview_id` property should be // kept the same for all these events so that they can be grouped // together properly. When using the client side event reporting with // JavaScript pixel and Google Tag Manager, this value is filled in @@ -2787,25 +2784,25 @@ type GoogleCloudDiscoveryengineV1betaSearchInfo struct { // Offset: An integer that specifies the current offset for pagination // (the 0-indexed starting location, amongst the products deemed by the // API as relevant). See SearchRequest.offset for definition. If this - // field is negative, an INVALID_ARGUMENT is returned. This can only be - // set for `search` events. Other event types should not set this field. - // Otherwise, an INVALID_ARGUMENT error is returned. + // field is negative, an `INVALID_ARGUMENT` is returned. This can only + // be set for `search` events. Other event types should not set this + // field. Otherwise, an `INVALID_ARGUMENT` error is returned. Offset int64 `json:"offset,omitempty"` // OrderBy: The order in which products are returned, if applicable. See // SearchRequest.order_by for definition and syntax. The value must be a // UTF-8 encoded string with a length limit of 1,000 characters. - // Otherwise, an INVALID_ARGUMENT error is returned. This can only be + // Otherwise, an `INVALID_ARGUMENT` error is returned. This can only be // set for `search` events. Other event types should not set this field. - // Otherwise, an INVALID_ARGUMENT error is returned. + // Otherwise, an `INVALID_ARGUMENT` error is returned. OrderBy string `json:"orderBy,omitempty"` // SearchQuery: The user's search query. See SearchRequest.query for // definition. The value must be a UTF-8 encoded string with a length - // limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is + // limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is // returned. At least one of search_query or PageInfo.page_category is // required for `search` events. Other event types should not set this - // field. Otherwise, an INVALID_ARGUMENT error is returned. + // field. Otherwise, an `INVALID_ARGUMENT` error is returned. SearchQuery string `json:"searchQuery,omitempty"` // ForceSendFields is a list of field names (e.g. "Offset") to @@ -2928,7 +2925,7 @@ type GoogleCloudDiscoveryengineV1betaUserEvent struct { // allowed. Each value must be a UTF-8 encoded string with a length // limit of 256 characters. * For number attributes, at most 400 values // are allowed. For product recommendations, an example of extra user - // information is ` traffic_channel`, which is how a user arrives at the + // information is `traffic_channel`, which is how a user arrives at the // site. Users can arrive at the site by coming to the site directly, // coming through Google search, or in other ways. Attributes map[string]GoogleCloudDiscoveryengineV1betaCustomAttribute `json:"attributes,omitempty"` @@ -2937,23 +2934,22 @@ type GoogleCloudDiscoveryengineV1betaUserEvent struct { // action(s) to trigger the event. Highly recommended for user events // that are the result of RecommendationService.Recommend. This field // enables accurate attribution of recommendation model performance. The - // value must be one of: * PredictResponse.attribution_token for events - // that are the result of RecommendationService.Recommend. * + // value must be one of: * RecommendResponse.attribution_token for + // events that are the result of RecommendationService.Recommend. * // SearchResponse.attribution_token for events that are the result of - // SearchService.Search. * CompleteQueryResponse.attribution_token for - // events that are the result of CompletionService.CompleteQuery. This - // token enables us to accurately attribute page view or conversion - // completion back to the event and the particular predict response - // containing this clicked/purchased product. If user clicks on product - // K in the recommendation results, pass - // PredictResponse.attribution_token as a URL parameter to product K's - // page. When recording events on product K's page, log the - // PredictResponse.attribution_token to this field. + // SearchService.Search. This token enables us to accurately attribute + // page view or conversion completion back to the event and the + // particular predict response containing this clicked/purchased + // product. If user clicks on product K in the recommendation results, + // pass RecommendResponse.attribution_token as a URL parameter to + // product K's page. When recording events on product K's page, log the + // RecommendResponse.attribution_token to this field. AttributionToken string `json:"attributionToken,omitempty"` - // CompletionInfo: CompleteQuery API details related to the event. This - // field should be set for `search` event when autocomplete function is - // enabled and the user clicks a suggestion for search. + // CompletionInfo: CompletionService.CompleteQuery details related to + // the event. This field should be set for `search` event when + // autocomplete function is enabled and the user clicks a suggestion for + // search. CompletionInfo *GoogleCloudDiscoveryengineV1betaCompletionInfo `json:"completionInfo,omitempty"` // DirectUserRequest: Should set to true if the request is made directly @@ -3001,7 +2997,7 @@ type GoogleCloudDiscoveryengineV1betaUserEvent struct { // directly from RecommendationService.RecommendRequest.filter // conforming to https://google.aip.dev/160#filtering. The value must be // a UTF-8 encoded string with a length limit of 1,000 characters. - // Otherwise, an INVALID_ARGUMENT error is returned. + // Otherwise, an `INVALID_ARGUMENT` error is returned. Filter string `json:"filter,omitempty"` // MediaInfo: Media-specific info. @@ -3018,8 +3014,8 @@ type GoogleCloudDiscoveryengineV1betaUserEvent struct { // promotions. Currently, this field is restricted to at most one ID. PromotionIds []string `json:"promotionIds,omitempty"` - // SearchInfo: Search API details related to the event. This field - // should be set for `search` event. + // SearchInfo: SearchService.Search details related to the event. This + // field should be set for `search` event. SearchInfo *GoogleCloudDiscoveryengineV1betaSearchInfo `json:"searchInfo,omitempty"` // SessionId: A unique identifier for tracking a visitor session with a @@ -3051,8 +3047,8 @@ type GoogleCloudDiscoveryengineV1betaUserEvent struct { // 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. The field should not contain PII - // or user-data. We recommend to use Google Analytics Client ID + // `INVALID_ARGUMENT` error is returned. The field should not contain + // PII or user-data. We recommend to use Google Analytics Client ID // (https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) // for this field. UserPseudoId string `json:"userPseudoId,omitempty"` @@ -3086,13 +3082,12 @@ func (s *GoogleCloudDiscoveryengineV1betaUserEvent) MarshalJSON() ([]byte, error // GoogleCloudDiscoveryengineV1betaUserInfo: Information of an end user. type GoogleCloudDiscoveryengineV1betaUserInfo struct { - // UserAgent: User agent as included in the HTTP header. Required for - // getting SearchResponse.sponsored_results. 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. + // UserAgent: 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. UserAgent string `json:"userAgent,omitempty"` // UserId: Highly recommended for logged-in users. Unique identifier for @@ -3950,7 +3945,7 @@ type ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall struct { // `projects/{project}/locations/{location}/collections/{collection}/da // taStores/{data_store}/branches/{branch}`. Use `default_branch` as // the branch ID, to list documents under the default branch. If the -// caller does not have permission to list Documentss under this +// caller does not have permission to list Documents under this // branch, regardless of whether or not this branch exists, a // `PERMISSION_DENIED` error is returned. func (r *ProjectsLocationsCollectionsDataStoresBranchesDocumentsService) List(parent string) *ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall { @@ -4100,7 +4095,7 @@ func (c *ProjectsLocationsCollectionsDataStoresBranchesDocumentsListCall) Do(opt // "type": "string" // }, // "parent": { - // "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", + // "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", // "required": true, @@ -6029,7 +6024,7 @@ type ProjectsLocationsCollectionsDataStoresUserEventsCollectCall struct { } // Collect: Writes a single user event from the browser. This uses a GET -// request to due to browser restriction of POST-ing to a 3rd party +// request to due to browser restriction of POST-ing to a third-party // domain. This method is used only by the Discovery Engine API // JavaScript pixel and Google Tag Manager. Users should not call this // method directly. @@ -6054,7 +6049,7 @@ func (c *ProjectsLocationsCollectionsDataStoresUserEventsCollectCall) Ets(ets in // Uri sets the optional parameter "uri": The URL including // cgi-parameters but excluding the hash fragment with a length limit of // 5,000 characters. This is often more useful than the referer URL, -// because many browsers only send the domain for 3rd party requests. +// because many browsers only send the domain for third-party requests. func (c *ProjectsLocationsCollectionsDataStoresUserEventsCollectCall) Uri(uri string) *ProjectsLocationsCollectionsDataStoresUserEventsCollectCall { c.urlParams_.Set("uri", uri) return c @@ -6166,7 +6161,7 @@ func (c *ProjectsLocationsCollectionsDataStoresUserEventsCollectCall) Do(opts .. } return ret, nil // { - // "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", + // "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", // "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:collect", // "httpMethod": "GET", // "id": "discoveryengine.projects.locations.collections.dataStores.userEvents.collect", @@ -6188,7 +6183,7 @@ func (c *ProjectsLocationsCollectionsDataStoresUserEventsCollectCall) Do(opts .. // "type": "string" // }, // "uri": { - // "description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.", + // "description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", // "location": "query", // "type": "string" // }, @@ -7836,7 +7831,7 @@ type ProjectsLocationsDataStoresBranchesDocumentsListCall struct { // `projects/{project}/locations/{location}/collections/{collection}/da // taStores/{data_store}/branches/{branch}`. Use `default_branch` as // the branch ID, to list documents under the default branch. If the -// caller does not have permission to list Documentss under this +// caller does not have permission to list Documents under this // branch, regardless of whether or not this branch exists, a // `PERMISSION_DENIED` error is returned. func (r *ProjectsLocationsDataStoresBranchesDocumentsService) List(parent string) *ProjectsLocationsDataStoresBranchesDocumentsListCall { @@ -7986,7 +7981,7 @@ func (c *ProjectsLocationsDataStoresBranchesDocumentsListCall) Do(opts ...google // "type": "string" // }, // "parent": { - // "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", + // "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", // "required": true, @@ -9560,7 +9555,7 @@ type ProjectsLocationsDataStoresUserEventsCollectCall struct { } // Collect: Writes a single user event from the browser. This uses a GET -// request to due to browser restriction of POST-ing to a 3rd party +// request to due to browser restriction of POST-ing to a third-party // domain. This method is used only by the Discovery Engine API // JavaScript pixel and Google Tag Manager. Users should not call this // method directly. @@ -9585,7 +9580,7 @@ func (c *ProjectsLocationsDataStoresUserEventsCollectCall) Ets(ets int64) *Proje // Uri sets the optional parameter "uri": The URL including // cgi-parameters but excluding the hash fragment with a length limit of // 5,000 characters. This is often more useful than the referer URL, -// because many browsers only send the domain for 3rd party requests. +// because many browsers only send the domain for third-party requests. func (c *ProjectsLocationsDataStoresUserEventsCollectCall) Uri(uri string) *ProjectsLocationsDataStoresUserEventsCollectCall { c.urlParams_.Set("uri", uri) return c @@ -9697,7 +9692,7 @@ func (c *ProjectsLocationsDataStoresUserEventsCollectCall) Do(opts ...googleapi. } return ret, nil // { - // "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", + // "description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", // "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:collect", // "httpMethod": "GET", // "id": "discoveryengine.projects.locations.dataStores.userEvents.collect", @@ -9719,7 +9714,7 @@ func (c *ProjectsLocationsDataStoresUserEventsCollectCall) Do(opts ...googleapi. // "type": "string" // }, // "uri": { - // "description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.", + // "description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", // "location": "query", // "type": "string" // }, diff --git a/displayvideo/v1/displayvideo-api.json b/displayvideo/v1/displayvideo-api.json index 0dfbb356132..31d6ae99346 100644 --- a/displayvideo/v1/displayvideo-api.json +++ b/displayvideo/v1/displayvideo-api.json @@ -1775,7 +1775,7 @@ "type": "string" }, "filter": { - "description": "Allows filtering by insertion order 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}`. * The `budget.budget_segments.date_range.end_date` field must use the `LESS THAN (\u003c)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\u003e=)` or `LESS THAN OR EQUAL TO (\u003c=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `budget.budget_segments.date_range.end_date` (input in the form of `YYYY-MM-DD`) * **Deprecated. Not available after June 21, 2023** * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003c=\"2020-11-04T18:54:47Z\"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003e=\"2020-11-04T18:54:47Z\"` 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.", + "description": "Allows filtering by insertion order 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}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\u003e=)` or `LESS THAN OR EQUAL TO (\u003c=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003c=\"2020-11-04T18:54:47Z\"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003e=\"2020-11-04T18:54:47Z\"` 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" }, @@ -2503,12 +2503,12 @@ "type": "string" }, "filter": { - "description": "Allows filtering by line item 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}`. * The `flight.dateRange.endDate` field must use the `LESS THAN (\u003c)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\u003e=)` or `LESS THAN OR EQUAL TO (\u003c=)` operators. * The `warningMessages` field must use the `HAS (:)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `flight.dateRange.endDate` (input formatted as `YYYY-MM-DD`) * **Deprecated. Not available after June 21, 2023** * `flight.triggerId` * **Deprecated. Not available after June 21, 2023** * `insertionOrderId` * `lineItemId` * `lineItemType` * `targetedChannelId` * **Deprecated. Not available after June 21, 2023** * `targetedNegativeKeywordListId` * **Deprecated. Not available after June 21, 2023** * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) * `warningMessages` * **Deprecated. Not available after June 21, 2023** Examples: * All line items under an insertion order: `insertionOrderId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND lineItemType=\"LINE_ITEM_TYPE_DISPLAY_DEFAULT\"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003c=\"2020-11-04T18:54:47Z\"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003e=\"2020-11-04T18:54:47Z\"` 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.", + "description": "Allows filtering by line item 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}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\u003e=)` or `LESS THAN OR EQUAL TO (\u003c=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * `lineItemType` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion order: `insertionOrderId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND lineItemType=\"LINE_ITEM_TYPE_DISPLAY_DEFAULT\"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003c=\"2020-11-04T18:54:47Z\"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003e=\"2020-11-04T18:54:47Z\"` 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) * `entityStatus` * `flight.dateRange.endDate` * **Deprecated. Not available after June 21, 2023** * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", "location": "query", "type": "string" }, @@ -6227,6 +6227,12 @@ "inventorySourceId" ], "parameters": { + "advertiserId": { + "description": "Optional. The advertiser_id is optional, when it is provided, the advertiser access is used.", + "format": "int64", + "location": "query", + "type": "string" + }, "inventorySourceId": { "description": "Required. The ID of the inventory source to fetch.", "format": "int64", @@ -8146,7 +8152,7 @@ } } }, - "revision": "20230615", + "revision": "20230627", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -10890,6 +10896,20 @@ "SDF_VERSION_5_5", "SDF_VERSION_6" ], + "enumDeprecated": [ + false, + true, + true, + true, + true, + true, + true, + true, + true, + false, + false, + false + ], "enumDescriptions": [ "SDF version value is not specified or is unknown in this version.", "SDF version 3.1", @@ -13114,6 +13134,17 @@ "YOUTUBE_USERS", "LICENSED" ], + "enumDeprecated": [ + false, + false, + false, + false, + true, + true, + false, + false, + false + ], "enumDescriptions": [ "Default value when type is not specified or is unknown.", "Audience was generated through matching customers to known contact information.", @@ -13715,6 +13746,15 @@ "GOOGLE_AUDIENCE_TYPE_LIFE_EVENT", "GOOGLE_AUDIENCE_TYPE_EXTENDED_DEMOGRAPHIC" ], + "enumDeprecated": [ + false, + false, + false, + true, + true, + false, + false + ], "enumDescriptions": [ "Default value when type is not specified or is unknown.", "Affinity type Google audience.", @@ -17094,6 +17134,12 @@ "PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP", "PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP" ], + "enumDeprecated": [ + false, + false, + true, + false + ], "enumDescriptions": [ "Type value is not specified or is unknown in this version.", "Calculate the partner revenue based on a fixed CPM.", @@ -17656,6 +17702,20 @@ "SDF_VERSION_5_5", "SDF_VERSION_6" ], + "enumDeprecated": [ + false, + true, + true, + true, + true, + true, + true, + true, + true, + false, + false, + false + ], "enumDescriptions": [ "SDF version value is not specified or is unknown in this version.", "SDF version 3.1", @@ -17716,6 +17776,20 @@ "SDF_VERSION_5_5", "SDF_VERSION_6" ], + "enumDeprecated": [ + false, + true, + true, + true, + true, + true, + true, + true, + true, + false, + false, + false + ], "enumDescriptions": [ "SDF version value is not specified or is unknown in this version.", "SDF version 3.1", @@ -17965,6 +18039,7 @@ "id": "TargetingExpansionConfig", "properties": { "excludeFirstPartyAudience": { + "deprecated": true, "description": "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.", "type": "boolean" }, @@ -17979,6 +18054,15 @@ "MORE_EXPANSION", "MOST_EXPANSION" ], + "enumDeprecated": [ + false, + false, + false, + true, + true, + true, + true + ], "enumDescriptions": [ "The optimized targeting setting is not specified or is unknown in this version.", "Optimized targeting is off.", diff --git a/displayvideo/v1/displayvideo-gen.go b/displayvideo/v1/displayvideo-gen.go index 26b20abbc36..10d799babff 100644 --- a/displayvideo/v1/displayvideo-gen.go +++ b/displayvideo/v1/displayvideo-gen.go @@ -22936,14 +22936,10 @@ func (r *AdvertisersInsertionOrdersService) List(advertiserId int64) *Advertiser // 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}`. * The -// `budget.budget_segments.date_range.end_date` field must use the `LESS -// THAN (<)` operator. * The `updateTime` field must use the `GREATER +// {operator} {value}`. * The `updateTime` field must use the `GREATER // THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * // All other fields must use the `EQUALS (=)` operator. Supported // fields: * `campaignId` * `displayName` * `entityStatus` * -// `budget.budget_segments.date_range.end_date` (input in the form of -// `YYYY-MM-DD`) * **Deprecated. Not available after June 21, 2023** * // `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) // Examples: * All insertion orders under a campaign: // `campaignId="1234" * All `ENTITY_STATUS_ACTIVE` or @@ -23107,7 +23103,7 @@ func (c *AdvertisersInsertionOrdersListCall) Do(opts ...googleapi.CallOption) (* // "type": "string" // }, // "filter": { - // "description": "Allows filtering by insertion order 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}`. * The `budget.budget_segments.date_range.end_date` field must use the `LESS THAN (\u003c)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\u003e=)` or `LESS THAN OR EQUAL TO (\u003c=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `budget.budget_segments.date_range.end_date` (input in the form of `YYYY-MM-DD`) * **Deprecated. Not available after June 21, 2023** * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003c=\"2020-11-04T18:54:47Z\"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003e=\"2020-11-04T18:54:47Z\"` 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.", + // "description": "Allows filtering by insertion order 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}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\u003e=)` or `LESS THAN OR EQUAL TO (\u003c=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003c=\"2020-11-04T18:54:47Z\"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003e=\"2020-11-04T18:54:47Z\"` 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" // }, @@ -25508,25 +25504,15 @@ func (r *AdvertisersLineItemsService) List(advertiserId int64) *AdvertisersLineI // 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}`. -// * The `flight.dateRange.endDate` field must use the `LESS THAN (<)` -// operator. * The `updateTime` field must use the `GREATER THAN OR -// EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * The -// `warningMessages` field must use the `HAS (:)` operator. * All other -// fields must use the `EQUALS (=)` operator. Supported fields: * -// `campaignId` * `displayName` * `entityStatus` * -// `flight.dateRange.endDate` (input formatted as `YYYY-MM-DD`) * -// **Deprecated. Not available after June 21, 2023** * -// `flight.triggerId` * **Deprecated. Not available after June 21, -// 2023** * `insertionOrderId` * `lineItemId` * `lineItemType` * -// `targetedChannelId` * **Deprecated. Not available after June 21, -// 2023** * `targetedNegativeKeywordListId` * **Deprecated. Not -// available after June 21, 2023** * `updateTime` (input in ISO 8601 -// format, or `YYYY-MM-DDTHH:MM:SSZ`) * `warningMessages` * -// **Deprecated. Not available after June 21, 2023** Examples: * All -// line items under an insertion order: `insertionOrderId="1234" * All -// `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and -// `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: -// `(entityStatus="ENTITY_STATUS_ACTIVE" OR +// * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` +// or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must +// use the `EQUALS (=)` operator. Supported fields: * `campaignId` * +// `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * +// `lineItemType` * `updateTime` (input in ISO 8601 format, or +// `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion +// order: `insertionOrderId="1234" * All `ENTITY_STATUS_ACTIVE` or +// `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line +// items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR // entityStatus="ENTITY_STATUS_PAUSED") AND // lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT" * All line items with // an update time less than or equal to 2020-11-04T18:54:47Z (format of @@ -25543,11 +25529,9 @@ func (c *AdvertisersLineItemsListCall) Filter(filter string) *AdvertisersLineIte // OrderBy sets the optional parameter "orderBy": Field by which to sort // the list. Acceptable values are: * `displayName` (default) * -// `entityStatus` * `flight.dateRange.endDate` * **Deprecated. Not -// available after June 21, 2023** * `updateTime` The default sorting -// order is ascending. To specify descending order for a field, a suffix -// "desc" should be added to the field name. Example: `displayName -// desc`. +// `entityStatus` * `updateTime` The default sorting order is ascending. +// To specify descending order for a field, a suffix "desc" should be +// added to the field name. Example: `displayName desc`. func (c *AdvertisersLineItemsListCall) OrderBy(orderBy string) *AdvertisersLineItemsListCall { c.urlParams_.Set("orderBy", orderBy) return c @@ -25688,12 +25672,12 @@ func (c *AdvertisersLineItemsListCall) Do(opts ...googleapi.CallOption) (*ListLi // "type": "string" // }, // "filter": { - // "description": "Allows filtering by line item 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}`. * The `flight.dateRange.endDate` field must use the `LESS THAN (\u003c)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\u003e=)` or `LESS THAN OR EQUAL TO (\u003c=)` operators. * The `warningMessages` field must use the `HAS (:)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `flight.dateRange.endDate` (input formatted as `YYYY-MM-DD`) * **Deprecated. Not available after June 21, 2023** * `flight.triggerId` * **Deprecated. Not available after June 21, 2023** * `insertionOrderId` * `lineItemId` * `lineItemType` * `targetedChannelId` * **Deprecated. Not available after June 21, 2023** * `targetedNegativeKeywordListId` * **Deprecated. Not available after June 21, 2023** * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) * `warningMessages` * **Deprecated. Not available after June 21, 2023** Examples: * All line items under an insertion order: `insertionOrderId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND lineItemType=\"LINE_ITEM_TYPE_DISPLAY_DEFAULT\"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003c=\"2020-11-04T18:54:47Z\"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003e=\"2020-11-04T18:54:47Z\"` 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.", + // "description": "Allows filtering by line item 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}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\u003e=)` or `LESS THAN OR EQUAL TO (\u003c=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * `lineItemType` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion order: `insertionOrderId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND lineItemType=\"LINE_ITEM_TYPE_DISPLAY_DEFAULT\"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003c=\"2020-11-04T18:54:47Z\"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003e=\"2020-11-04T18:54:47Z\"` 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) * `entityStatus` * `flight.dateRange.endDate` * **Deprecated. Not available after June 21, 2023** * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + // "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", // "location": "query", // "type": "string" // }, @@ -39430,6 +39414,14 @@ func (r *InventorySourcesService) Get(inventorySourceId int64) *InventorySources return c } +// AdvertiserId sets the optional parameter "advertiserId": The +// advertiser_id is optional, when it is provided, the advertiser access +// is used. +func (c *InventorySourcesGetCall) AdvertiserId(advertiserId int64) *InventorySourcesGetCall { + c.urlParams_.Set("advertiserId", fmt.Sprint(advertiserId)) + return c +} + // PartnerId sets the optional parameter "partnerId": Required. The ID // of the DV360 partner to which the fetched inventory source is // permissioned. @@ -39545,6 +39537,12 @@ func (c *InventorySourcesGetCall) Do(opts ...googleapi.CallOption) (*InventorySo // "inventorySourceId" // ], // "parameters": { + // "advertiserId": { + // "description": "Optional. The advertiser_id is optional, when it is provided, the advertiser access is used.", + // "format": "int64", + // "location": "query", + // "type": "string" + // }, // "inventorySourceId": { // "description": "Required. The ID of the inventory source to fetch.", // "format": "int64", diff --git a/displayvideo/v2/displayvideo-api.json b/displayvideo/v2/displayvideo-api.json index ba121919d69..3e8575badd3 100644 --- a/displayvideo/v2/displayvideo-api.json +++ b/displayvideo/v2/displayvideo-api.json @@ -1731,7 +1731,7 @@ "type": "string" }, "filter": { - "description": "Allows filtering by insertion order 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}`. * The `budget.budget_segments.date_range.end_date` field must use the `LESS THAN (\u003c)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\u003e=)` or `LESS THAN OR EQUAL TO (\u003c=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `budget.budget_segments.date_range.end_date` (input in the form of `YYYY-MM-DD`) * **Deprecated. Not available after June 21, 2023** * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003c=\"2020-11-04T18:54:47Z\"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003e=\"2020-11-04T18:54:47Z\"` 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.", + "description": "Allows filtering by insertion order 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}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\u003e=)` or `LESS THAN OR EQUAL TO (\u003c=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003c=\"2020-11-04T18:54:47Z\"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003e=\"2020-11-04T18:54:47Z\"` 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" }, @@ -2884,12 +2884,12 @@ "type": "string" }, "filter": { - "description": "Allows filtering by line item 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}`. * The `flight.dateRange.endDate` field must use the `LESS THAN (\u003c)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\u003e=)` or `LESS THAN OR EQUAL TO (\u003c=)` operators. * The `warningMessages` field must use the `HAS (:)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `flight.dateRange.endDate` (input formatted as `YYYY-MM-DD`) * **Deprecated. Not available after June 21, 2023** * `flight.triggerId` * **Deprecated. Not available after June 21, 2023** * `insertionOrderId` * `lineItemId` * `lineItemType` * `targetedChannelId` * **Deprecated. Not available after June 21, 2023** * `targetedNegativeKeywordListId` * **Deprecated. Not available after June 21, 2023** * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) * `warningMessages` * **Deprecated. Not available after June 21, 2023** Examples: * All line items under an insertion order: `insertionOrderId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND lineItemType=\"LINE_ITEM_TYPE_DISPLAY_DEFAULT\"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003c=\"2020-11-04T18:54:47Z\"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003e=\"2020-11-04T18:54:47Z\"` 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.", + "description": "Allows filtering by line item 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}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\u003e=)` or `LESS THAN OR EQUAL TO (\u003c=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * `lineItemType` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion order: `insertionOrderId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND lineItemType=\"LINE_ITEM_TYPE_DISPLAY_DEFAULT\"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003c=\"2020-11-04T18:54:47Z\"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003e=\"2020-11-04T18:54:47Z\"` 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) * `entityStatus` * `flight.dateRange.endDate` * **Deprecated. Not available after June 21, 2023** * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", "location": "query", "type": "string" }, @@ -7211,6 +7211,12 @@ "inventorySourceId" ], "parameters": { + "advertiserId": { + "description": "Optional. The advertiser_id is optional, when it is provided, the advertiser access is used.", + "format": "int64", + "location": "query", + "type": "string" + }, "inventorySourceId": { "description": "Required. The ID of the inventory source to fetch.", "format": "int64", @@ -9172,7 +9178,7 @@ } } }, - "revision": "20230615", + "revision": "20230627", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -12188,6 +12194,20 @@ "SDF_VERSION_5_5", "SDF_VERSION_6" ], + "enumDeprecated": [ + false, + true, + true, + true, + true, + true, + true, + true, + true, + false, + false, + false + ], "enumDescriptions": [ "SDF version value is not specified or is unknown in this version.", "SDF version 3.1", @@ -14634,6 +14654,17 @@ "YOUTUBE_USERS", "LICENSED" ], + "enumDeprecated": [ + false, + false, + false, + false, + true, + true, + false, + false, + false + ], "enumDescriptions": [ "Default value when type is not specified or is unknown.", "Audience was generated through matching customers to known contact information.", @@ -15256,6 +15287,15 @@ "GOOGLE_AUDIENCE_TYPE_LIFE_EVENT", "GOOGLE_AUDIENCE_TYPE_EXTENDED_DEMOGRAPHIC" ], + "enumDeprecated": [ + false, + false, + false, + true, + true, + false, + false + ], "enumDescriptions": [ "Default value when type is not specified or is unknown.", "Affinity type Google audience.", @@ -18813,6 +18853,12 @@ "PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP", "PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP" ], + "enumDeprecated": [ + false, + false, + true, + false + ], "enumDescriptions": [ "Type value is not specified or is unknown in this version.", "Calculate the partner revenue based on a fixed CPM.", @@ -19427,6 +19473,20 @@ "SDF_VERSION_5_5", "SDF_VERSION_6" ], + "enumDeprecated": [ + false, + true, + true, + true, + true, + true, + true, + true, + true, + false, + false, + false + ], "enumDescriptions": [ "SDF version value is not specified or is unknown in this version.", "SDF version 3.1", @@ -19487,6 +19547,20 @@ "SDF_VERSION_5_5", "SDF_VERSION_6" ], + "enumDeprecated": [ + false, + true, + true, + true, + true, + true, + true, + true, + true, + false, + false, + false + ], "enumDescriptions": [ "SDF version value is not specified or is unknown in this version.", "SDF version 3.1", @@ -19797,6 +19871,7 @@ "id": "TargetingExpansionConfig", "properties": { "excludeFirstPartyAudience": { + "deprecated": true, "description": "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.", "type": "boolean" }, @@ -19811,6 +19886,15 @@ "MORE_EXPANSION", "MOST_EXPANSION" ], + "enumDeprecated": [ + false, + false, + false, + true, + true, + true, + true + ], "enumDescriptions": [ "The optimized targeting setting is not specified or is unknown in this version.", "Optimized targeting is off.", diff --git a/displayvideo/v2/displayvideo-gen.go b/displayvideo/v2/displayvideo-gen.go index d1434ca532a..f9e4c849f02 100644 --- a/displayvideo/v2/displayvideo-gen.go +++ b/displayvideo/v2/displayvideo-gen.go @@ -24879,14 +24879,10 @@ func (r *AdvertisersInsertionOrdersService) List(advertiserId int64) *Advertiser // 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}`. * The -// `budget.budget_segments.date_range.end_date` field must use the `LESS -// THAN (<)` operator. * The `updateTime` field must use the `GREATER +// {operator} {value}`. * The `updateTime` field must use the `GREATER // THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * // All other fields must use the `EQUALS (=)` operator. Supported // fields: * `campaignId` * `displayName` * `entityStatus` * -// `budget.budget_segments.date_range.end_date` (input in the form of -// `YYYY-MM-DD`) * **Deprecated. Not available after June 21, 2023** * // `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) // Examples: * All insertion orders under a campaign: // `campaignId="1234" * All `ENTITY_STATUS_ACTIVE` or @@ -25050,7 +25046,7 @@ func (c *AdvertisersInsertionOrdersListCall) Do(opts ...googleapi.CallOption) (* // "type": "string" // }, // "filter": { - // "description": "Allows filtering by insertion order 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}`. * The `budget.budget_segments.date_range.end_date` field must use the `LESS THAN (\u003c)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\u003e=)` or `LESS THAN OR EQUAL TO (\u003c=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `budget.budget_segments.date_range.end_date` (input in the form of `YYYY-MM-DD`) * **Deprecated. Not available after June 21, 2023** * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003c=\"2020-11-04T18:54:47Z\"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003e=\"2020-11-04T18:54:47Z\"` 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.", + // "description": "Allows filtering by insertion order 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}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\u003e=)` or `LESS THAN OR EQUAL TO (\u003c=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003c=\"2020-11-04T18:54:47Z\"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003e=\"2020-11-04T18:54:47Z\"` 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" // }, @@ -28606,25 +28602,15 @@ func (r *AdvertisersLineItemsService) List(advertiserId int64) *AdvertisersLineI // 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}`. -// * The `flight.dateRange.endDate` field must use the `LESS THAN (<)` -// operator. * The `updateTime` field must use the `GREATER THAN OR -// EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * The -// `warningMessages` field must use the `HAS (:)` operator. * All other -// fields must use the `EQUALS (=)` operator. Supported fields: * -// `campaignId` * `displayName` * `entityStatus` * -// `flight.dateRange.endDate` (input formatted as `YYYY-MM-DD`) * -// **Deprecated. Not available after June 21, 2023** * -// `flight.triggerId` * **Deprecated. Not available after June 21, -// 2023** * `insertionOrderId` * `lineItemId` * `lineItemType` * -// `targetedChannelId` * **Deprecated. Not available after June 21, -// 2023** * `targetedNegativeKeywordListId` * **Deprecated. Not -// available after June 21, 2023** * `updateTime` (input in ISO 8601 -// format, or `YYYY-MM-DDTHH:MM:SSZ`) * `warningMessages` * -// **Deprecated. Not available after June 21, 2023** Examples: * All -// line items under an insertion order: `insertionOrderId="1234" * All -// `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and -// `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: -// `(entityStatus="ENTITY_STATUS_ACTIVE" OR +// * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` +// or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must +// use the `EQUALS (=)` operator. Supported fields: * `campaignId` * +// `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * +// `lineItemType` * `updateTime` (input in ISO 8601 format, or +// `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion +// order: `insertionOrderId="1234" * All `ENTITY_STATUS_ACTIVE` or +// `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line +// items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR // entityStatus="ENTITY_STATUS_PAUSED") AND // lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT" * All line items with // an update time less than or equal to 2020-11-04T18:54:47Z (format of @@ -28641,11 +28627,9 @@ func (c *AdvertisersLineItemsListCall) Filter(filter string) *AdvertisersLineIte // OrderBy sets the optional parameter "orderBy": Field by which to sort // the list. Acceptable values are: * `displayName` (default) * -// `entityStatus` * `flight.dateRange.endDate` * **Deprecated. Not -// available after June 21, 2023** * `updateTime` The default sorting -// order is ascending. To specify descending order for a field, a suffix -// "desc" should be added to the field name. Example: `displayName -// desc`. +// `entityStatus` * `updateTime` The default sorting order is ascending. +// To specify descending order for a field, a suffix "desc" should be +// added to the field name. Example: `displayName desc`. func (c *AdvertisersLineItemsListCall) OrderBy(orderBy string) *AdvertisersLineItemsListCall { c.urlParams_.Set("orderBy", orderBy) return c @@ -28786,12 +28770,12 @@ func (c *AdvertisersLineItemsListCall) Do(opts ...googleapi.CallOption) (*ListLi // "type": "string" // }, // "filter": { - // "description": "Allows filtering by line item 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}`. * The `flight.dateRange.endDate` field must use the `LESS THAN (\u003c)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\u003e=)` or `LESS THAN OR EQUAL TO (\u003c=)` operators. * The `warningMessages` field must use the `HAS (:)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `flight.dateRange.endDate` (input formatted as `YYYY-MM-DD`) * **Deprecated. Not available after June 21, 2023** * `flight.triggerId` * **Deprecated. Not available after June 21, 2023** * `insertionOrderId` * `lineItemId` * `lineItemType` * `targetedChannelId` * **Deprecated. Not available after June 21, 2023** * `targetedNegativeKeywordListId` * **Deprecated. Not available after June 21, 2023** * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) * `warningMessages` * **Deprecated. Not available after June 21, 2023** Examples: * All line items under an insertion order: `insertionOrderId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND lineItemType=\"LINE_ITEM_TYPE_DISPLAY_DEFAULT\"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003c=\"2020-11-04T18:54:47Z\"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003e=\"2020-11-04T18:54:47Z\"` 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.", + // "description": "Allows filtering by line item 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}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\u003e=)` or `LESS THAN OR EQUAL TO (\u003c=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * `lineItemType` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion order: `insertionOrderId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND lineItemType=\"LINE_ITEM_TYPE_DISPLAY_DEFAULT\"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003c=\"2020-11-04T18:54:47Z\"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\u003e=\"2020-11-04T18:54:47Z\"` 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) * `entityStatus` * `flight.dateRange.endDate` * **Deprecated. Not available after June 21, 2023** * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + // "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", // "location": "query", // "type": "string" // }, @@ -44309,6 +44293,14 @@ func (r *InventorySourcesService) Get(inventorySourceId int64) *InventorySources return c } +// AdvertiserId sets the optional parameter "advertiserId": The +// advertiser_id is optional, when it is provided, the advertiser access +// is used. +func (c *InventorySourcesGetCall) AdvertiserId(advertiserId int64) *InventorySourcesGetCall { + c.urlParams_.Set("advertiserId", fmt.Sprint(advertiserId)) + return c +} + // PartnerId sets the optional parameter "partnerId": Required. The ID // of the DV360 partner to which the fetched inventory source is // permissioned. @@ -44424,6 +44416,12 @@ func (c *InventorySourcesGetCall) Do(opts ...googleapi.CallOption) (*InventorySo // "inventorySourceId" // ], // "parameters": { + // "advertiserId": { + // "description": "Optional. The advertiser_id is optional, when it is provided, the advertiser access is used.", + // "format": "int64", + // "location": "query", + // "type": "string" + // }, // "inventorySourceId": { // "description": "Required. The ID of the inventory source to fetch.", // "format": "int64", diff --git a/firestore/v1/firestore-api.json b/firestore/v1/firestore-api.json index 289f3d1811a..abe52fd8552 100644 --- a/firestore/v1/firestore-api.json +++ b/firestore/v1/firestore-api.json @@ -540,7 +540,7 @@ ] }, "list": { - "description": "Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false` .", + "description": "Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false or `ttlConfig:*`.", "flatPath": "v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/fields", "httpMethod": "GET", "id": "firestore.projects.databases.collectionGroups.fields.list", @@ -1682,7 +1682,7 @@ } } }, - "revision": "20230611", + "revision": "20230621", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -3106,6 +3106,55 @@ }, "type": "object" }, + "GoogleFirestoreAdminV1RestoreDatabaseMetadata": { + "description": "Metadata for the long-running operation from the RestoreDatabase request.", + "id": "GoogleFirestoreAdminV1RestoreDatabaseMetadata", + "properties": { + "backup": { + "description": "The name of the backup restoring from.", + "type": "string" + }, + "database": { + "description": "The name of the database being restored to.", + "type": "string" + }, + "endTime": { + "description": "The time the restore finished, unset for ongoing restores.", + "format": "google-datetime", + "type": "string" + }, + "operationState": { + "description": "The operation state of the restore.", + "enum": [ + "OPERATION_STATE_UNSPECIFIED", + "INITIALIZING", + "PROCESSING", + "CANCELLING", + "FINALIZING", + "SUCCESSFUL", + "FAILED", + "CANCELLED" + ], + "enumDescriptions": [ + "Unspecified.", + "Request is being prepared for processing.", + "Request is actively being processed.", + "Request is in the process of being cancelled after user called google.longrunning.Operations.CancelOperation on the operation.", + "Request has been processed and is in its finalization stage.", + "Request has completed successfully.", + "Request has finished being processed, but encountered an error.", + "Request has finished being cancelled after user called google.longrunning.Operations.CancelOperation." + ], + "type": "string" + }, + "startTime": { + "description": "The time the restore was started.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleFirestoreAdminV1RestoreDatabaseRequest": { "description": "The request message for FirestoreAdmin.RestoreDatabase.", "id": "GoogleFirestoreAdminV1RestoreDatabaseRequest", @@ -3608,7 +3657,7 @@ "type": "object" }, "ReadWrite": { - "description": "Options for a transaction that can be used to read and write documents.", + "description": "Options for a transaction that can be used to read and write documents. Firestore does not allow 3rd party auth requests to create read-write. transactions.", "id": "ReadWrite", "properties": { "retryTransaction": { diff --git a/firestore/v1/firestore-gen.go b/firestore/v1/firestore-gen.go index 5e588c4818a..eba08306e12 100644 --- a/firestore/v1/firestore-gen.go +++ b/firestore/v1/firestore-gen.go @@ -2668,6 +2668,62 @@ func (s *GoogleFirestoreAdminV1Progress) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleFirestoreAdminV1RestoreDatabaseMetadata: Metadata for the +// long-running operation from the RestoreDatabase request. +type GoogleFirestoreAdminV1RestoreDatabaseMetadata struct { + // Backup: The name of the backup restoring from. + Backup string `json:"backup,omitempty"` + + // Database: The name of the database being restored to. + Database string `json:"database,omitempty"` + + // EndTime: The time the restore finished, unset for ongoing restores. + EndTime string `json:"endTime,omitempty"` + + // OperationState: The operation state of the restore. + // + // Possible values: + // "OPERATION_STATE_UNSPECIFIED" - Unspecified. + // "INITIALIZING" - Request is being prepared for processing. + // "PROCESSING" - Request is actively being processed. + // "CANCELLING" - Request is in the process of being cancelled after + // user called google.longrunning.Operations.CancelOperation on the + // operation. + // "FINALIZING" - Request has been processed and is in its + // finalization stage. + // "SUCCESSFUL" - Request has completed successfully. + // "FAILED" - Request has finished being processed, but encountered an + // error. + // "CANCELLED" - Request has finished being cancelled after user + // called google.longrunning.Operations.CancelOperation. + OperationState string `json:"operationState,omitempty"` + + // StartTime: The time the restore was started. + StartTime string `json:"startTime,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Backup") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Backup") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleFirestoreAdminV1RestoreDatabaseMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleFirestoreAdminV1RestoreDatabaseMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleFirestoreAdminV1RestoreDatabaseRequest: The request message for // FirestoreAdmin.RestoreDatabase. type GoogleFirestoreAdminV1RestoreDatabaseRequest struct { @@ -3615,7 +3671,8 @@ func (s *ReadOnly) MarshalJSON() ([]byte, error) { } // ReadWrite: Options for a transaction that can be used to read and -// write documents. +// write documents. Firestore does not allow 3rd party auth requests to +// create read-write. transactions. type ReadWrite struct { // RetryTransaction: An optional transaction to retry. RetryTransaction string `json:"retryTransaction,omitempty"` @@ -6649,7 +6706,7 @@ type ProjectsDatabasesCollectionGroupsFieldsListCall struct { // Currently, FirestoreAdmin.ListFields only supports listing fields // that have been explicitly overridden. To issue this query, call // FirestoreAdmin.ListFields with the filter set to -// `indexConfig.usesAncestorConfig:false` . +// `indexConfig.usesAncestorConfig:false or `ttlConfig:*`. // // - parent: A parent name of the form // `projects/{project_id}/databases/{database_id}/collectionGroups/{col @@ -6786,7 +6843,7 @@ func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) Do(opts ...googleapi.C } return ret, nil // { - // "description": "Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false` .", + // "description": "Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false or `ttlConfig:*`.", // "flatPath": "v1/projects/{projectsId}/databases/{databasesId}/collectionGroups/{collectionGroupsId}/fields", // "httpMethod": "GET", // "id": "firestore.projects.databases.collectionGroups.fields.list", diff --git a/firestore/v1beta1/firestore-api.json b/firestore/v1beta1/firestore-api.json index 8eb01640981..671eb0282b2 100644 --- a/firestore/v1beta1/firestore-api.json +++ b/firestore/v1beta1/firestore-api.json @@ -950,7 +950,7 @@ } } }, - "revision": "20230611", + "revision": "20230621", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -1556,6 +1556,55 @@ }, "type": "object" }, + "GoogleFirestoreAdminV1RestoreDatabaseMetadata": { + "description": "Metadata for the long-running operation from the RestoreDatabase request.", + "id": "GoogleFirestoreAdminV1RestoreDatabaseMetadata", + "properties": { + "backup": { + "description": "The name of the backup restoring from.", + "type": "string" + }, + "database": { + "description": "The name of the database being restored to.", + "type": "string" + }, + "endTime": { + "description": "The time the restore finished, unset for ongoing restores.", + "format": "google-datetime", + "type": "string" + }, + "operationState": { + "description": "The operation state of the restore.", + "enum": [ + "OPERATION_STATE_UNSPECIFIED", + "INITIALIZING", + "PROCESSING", + "CANCELLING", + "FINALIZING", + "SUCCESSFUL", + "FAILED", + "CANCELLED" + ], + "enumDescriptions": [ + "Unspecified.", + "Request is being prepared for processing.", + "Request is actively being processed.", + "Request is in the process of being cancelled after user called google.longrunning.Operations.CancelOperation on the operation.", + "Request has been processed and is in its finalization stage.", + "Request has completed successfully.", + "Request has finished being processed, but encountered an error.", + "Request has finished being cancelled after user called google.longrunning.Operations.CancelOperation." + ], + "type": "string" + }, + "startTime": { + "description": "The time the restore was started.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleFirestoreAdminV1UpdateDatabaseMetadata": { "description": "Metadata related to the update database operation.", "id": "GoogleFirestoreAdminV1UpdateDatabaseMetadata", @@ -2180,7 +2229,7 @@ "type": "object" }, "ReadWrite": { - "description": "Options for a transaction that can be used to read and write documents.", + "description": "Options for a transaction that can be used to read and write documents. Firestore does not allow 3rd party auth requests to create read-write. transactions.", "id": "ReadWrite", "properties": { "retryTransaction": { diff --git a/firestore/v1beta1/firestore-gen.go b/firestore/v1beta1/firestore-gen.go index c1f1d87cb2b..b28bb88e92b 100644 --- a/firestore/v1beta1/firestore-gen.go +++ b/firestore/v1beta1/firestore-gen.go @@ -1399,6 +1399,62 @@ func (s *Filter) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleFirestoreAdminV1RestoreDatabaseMetadata: Metadata for the +// long-running operation from the RestoreDatabase request. +type GoogleFirestoreAdminV1RestoreDatabaseMetadata struct { + // Backup: The name of the backup restoring from. + Backup string `json:"backup,omitempty"` + + // Database: The name of the database being restored to. + Database string `json:"database,omitempty"` + + // EndTime: The time the restore finished, unset for ongoing restores. + EndTime string `json:"endTime,omitempty"` + + // OperationState: The operation state of the restore. + // + // Possible values: + // "OPERATION_STATE_UNSPECIFIED" - Unspecified. + // "INITIALIZING" - Request is being prepared for processing. + // "PROCESSING" - Request is actively being processed. + // "CANCELLING" - Request is in the process of being cancelled after + // user called google.longrunning.Operations.CancelOperation on the + // operation. + // "FINALIZING" - Request has been processed and is in its + // finalization stage. + // "SUCCESSFUL" - Request has completed successfully. + // "FAILED" - Request has finished being processed, but encountered an + // error. + // "CANCELLED" - Request has finished being cancelled after user + // called google.longrunning.Operations.CancelOperation. + OperationState string `json:"operationState,omitempty"` + + // StartTime: The time the restore was started. + StartTime string `json:"startTime,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Backup") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Backup") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleFirestoreAdminV1RestoreDatabaseMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleFirestoreAdminV1RestoreDatabaseMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleFirestoreAdminV1UpdateDatabaseMetadata: Metadata related to the // update database operation. type GoogleFirestoreAdminV1UpdateDatabaseMetadata struct { @@ -2483,7 +2539,8 @@ func (s *ReadOnly) MarshalJSON() ([]byte, error) { } // ReadWrite: Options for a transaction that can be used to read and -// write documents. +// write documents. Firestore does not allow 3rd party auth requests to +// create read-write. transactions. type ReadWrite struct { // RetryTransaction: An optional transaction to retry. RetryTransaction string `json:"retryTransaction,omitempty"` diff --git a/firestore/v1beta2/firestore-api.json b/firestore/v1beta2/firestore-api.json index 4e721809ed7..27a686c55b3 100644 --- a/firestore/v1beta2/firestore-api.json +++ b/firestore/v1beta2/firestore-api.json @@ -415,7 +415,7 @@ } } }, - "revision": "20220319", + "revision": "20230621", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Empty": { @@ -424,6 +424,55 @@ "properties": {}, "type": "object" }, + "GoogleFirestoreAdminV1RestoreDatabaseMetadata": { + "description": "Metadata for the long-running operation from the RestoreDatabase request.", + "id": "GoogleFirestoreAdminV1RestoreDatabaseMetadata", + "properties": { + "backup": { + "description": "The name of the backup restoring from.", + "type": "string" + }, + "database": { + "description": "The name of the database being restored to.", + "type": "string" + }, + "endTime": { + "description": "The time the restore finished, unset for ongoing restores.", + "format": "google-datetime", + "type": "string" + }, + "operationState": { + "description": "The operation state of the restore.", + "enum": [ + "OPERATION_STATE_UNSPECIFIED", + "INITIALIZING", + "PROCESSING", + "CANCELLING", + "FINALIZING", + "SUCCESSFUL", + "FAILED", + "CANCELLED" + ], + "enumDescriptions": [ + "Unspecified.", + "Request is being prepared for processing.", + "Request is actively being processed.", + "Request is in the process of being cancelled after user called google.longrunning.Operations.CancelOperation on the operation.", + "Request has been processed and is in its finalization stage.", + "Request has completed successfully.", + "Request has finished being processed, but encountered an error.", + "Request has finished being cancelled after user called google.longrunning.Operations.CancelOperation." + ], + "type": "string" + }, + "startTime": { + "description": "The time the restore was started.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleFirestoreAdminV1UpdateDatabaseMetadata": { "description": "Metadata related to the update database operation.", "id": "GoogleFirestoreAdminV1UpdateDatabaseMetadata", diff --git a/firestore/v1beta2/firestore-gen.go b/firestore/v1beta2/firestore-gen.go index d9250ec402d..f5a0c87fc2c 100644 --- a/firestore/v1beta2/firestore-gen.go +++ b/firestore/v1beta2/firestore-gen.go @@ -216,6 +216,62 @@ type Empty struct { googleapi.ServerResponse `json:"-"` } +// GoogleFirestoreAdminV1RestoreDatabaseMetadata: Metadata for the +// long-running operation from the RestoreDatabase request. +type GoogleFirestoreAdminV1RestoreDatabaseMetadata struct { + // Backup: The name of the backup restoring from. + Backup string `json:"backup,omitempty"` + + // Database: The name of the database being restored to. + Database string `json:"database,omitempty"` + + // EndTime: The time the restore finished, unset for ongoing restores. + EndTime string `json:"endTime,omitempty"` + + // OperationState: The operation state of the restore. + // + // Possible values: + // "OPERATION_STATE_UNSPECIFIED" - Unspecified. + // "INITIALIZING" - Request is being prepared for processing. + // "PROCESSING" - Request is actively being processed. + // "CANCELLING" - Request is in the process of being cancelled after + // user called google.longrunning.Operations.CancelOperation on the + // operation. + // "FINALIZING" - Request has been processed and is in its + // finalization stage. + // "SUCCESSFUL" - Request has completed successfully. + // "FAILED" - Request has finished being processed, but encountered an + // error. + // "CANCELLED" - Request has finished being cancelled after user + // called google.longrunning.Operations.CancelOperation. + OperationState string `json:"operationState,omitempty"` + + // StartTime: The time the restore was started. + StartTime string `json:"startTime,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Backup") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Backup") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleFirestoreAdminV1RestoreDatabaseMetadata) MarshalJSON() ([]byte, error) { + type NoMethod GoogleFirestoreAdminV1RestoreDatabaseMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleFirestoreAdminV1UpdateDatabaseMetadata: Metadata related to the // update database operation. type GoogleFirestoreAdminV1UpdateDatabaseMetadata struct { diff --git a/iam/v1/iam-api.json b/iam/v1/iam-api.json index d932daf37eb..533e7731c7e 100644 --- a/iam/v1/iam-api.json +++ b/iam/v1/iam-api.json @@ -1379,6 +1379,138 @@ } }, "resources": { + "namespaces": { + "resources": { + "managedIdentities": { + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "workloadSources": { + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}/workloadSources/{workloadSourcesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.workloadSources.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+/workloadSources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "iam.projects.locations.workloadIdentityPools.namespaces.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "workloadSources": { + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/workloadSources/{workloadSourcesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "iam.projects.locations.workloadIdentityPools.namespaces.workloadSources.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/workloadSources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, "operations": { "methods": { "get": { @@ -2751,7 +2883,7 @@ } } }, - "revision": "20230530", + "revision": "20230622", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AdminAuditData": { @@ -3050,6 +3182,10 @@ "description": "Required. The client ID. Must match the audience claim of the JWT issued by the identity provider.", "type": "string" }, + "clientSecret": { + "$ref": "GoogleIamAdminV1WorkforcePoolProviderOidcClientSecret", + "description": "The optional client secret. Required to enable Authorization Code flow for web sign-in." + }, "issuerUri": { "description": "Required. The OIDC issuer URI. Must be a valid URI using the 'https' scheme.", "type": "string" @@ -3061,18 +3197,54 @@ }, "type": "object" }, + "GoogleIamAdminV1WorkforcePoolProviderOidcClientSecret": { + "description": "Representation of a client secret configured for the OIDC provider.", + "id": "GoogleIamAdminV1WorkforcePoolProviderOidcClientSecret", + "properties": { + "value": { + "$ref": "GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretValue", + "description": "The value of the client secret." + } + }, + "type": "object" + }, + "GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretValue": { + "description": "Representation of the value of the client secret.", + "id": "GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretValue", + "properties": { + "plainText": { + "description": "Input only. The plain text of the client secret value. For security reasons, this field is only used for input and will never be populated in any response.", + "type": "string" + }, + "thumbprint": { + "description": "Output only. A thumbprint to represent the current client secret value.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfig": { "description": "Configuration for web single sign-on for the OIDC provider.", "id": "GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfig", "properties": { + "additionalScopes": { + "description": "Additional scopes to request for in the OIDC authentication request on top of scopes requested by default. By default, the `openid`, `profile` and `email` scopes that are supported by the identity provider are requested. Each additional scope may be at most 256 characters. A maximum of 10 additional scopes may be configured.", + "items": { + "type": "string" + }, + "type": "array" + }, "assertionClaimsBehavior": { "description": "Required. The behavior for how OIDC Claims are included in the `assertion` object used for attribute mapping and attribute condition.", "enum": [ "ASSERTION_CLAIMS_BEHAVIOR_UNSPECIFIED", + "MERGE_USER_INFO_OVER_ID_TOKEN_CLAIMS", "ONLY_ID_TOKEN_CLAIMS" ], "enumDescriptions": [ "No assertion claims behavior specified.", + "Merge the UserInfo Endpoint Claims with ID Token Claims, preferring UserInfo Claim Values for the same Claim Name. Only possible for flows granting an Access Token, which comprise only the Authorization Code Flow at the moment.", "Only include ID Token Claims." ], "type": "string" @@ -3081,10 +3253,12 @@ "description": "Required. The Response Type to request for in the OIDC Authorization Request for web sign-in.", "enum": [ "RESPONSE_TYPE_UNSPECIFIED", + "CODE", "ID_TOKEN" ], "enumDescriptions": [ "No Response Type specified.", + "The `response_type=code` selection uses the Authorization Code Flow for web sign-in. Requires a configured client secret.", "The `response_type=id_token` selection uses the Implicit Flow for web sign-in." ], "type": "string" @@ -3733,7 +3907,7 @@ "type": "array" }, "name": { - "description": "The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.", + "description": "The name of the role. When `Role` is used in `CreateRole`, the role name must not be set. When `Role` is used in output and other input such as `UpdateRole`, the role name is the complete path. For example, `roles/logging.viewer` for predefined roles, `organizations/{ORGANIZATION_ID}/roles/my-role` for organization-level custom roles, and `projects/{PROJECT_ID}/roles/my-role` for project-level custom roles.", "type": "string" }, "stage": { @@ -4292,6 +4466,20 @@ "description": "A display name for the pool. Cannot exceed 32 characters.", "type": "string" }, + "identityMode": { + "description": "Immutable. The identity mode of the pool.", + "enum": [ + "IDENTITY_MODE_UNSPECIFIED", + "FEDERATION_ONLY", + "TRUST_DOMAIN" + ], + "enumDescriptions": [ + "Existing pools will be in this mode. For existing worklod identity pools created through the public API, they will act as if they are set to FEDERATION_ONLY.", + "With FEDERATION_ONLY mode, providers can be created at the root level within the pool. Attribute mappings must specify a \"google.subject\" claim that specifies the identity of the federation workload. Namespace or any sub-namespace resources is not allowed with this mode.", + "With TRUST_DOMAIN mode, providers can be created at the root level within the pool. Attribute mappings must specify the \"google.namespace\" and \"google.workload_identifier\" claims that, respectively, specify the namespace and individual sub-namespace identifier for the workload. Namespaces and sub-Namespace resources are allowed." + ], + "type": "string" + }, "name": { "description": "Output only. The resource name of the pool.", "readOnly": true, diff --git a/iam/v1/iam-gen.go b/iam/v1/iam-gen.go index 3a89574dafa..f1ea03e96de 100644 --- a/iam/v1/iam-gen.go +++ b/iam/v1/iam-gen.go @@ -329,6 +329,7 @@ type ProjectsLocationsService struct { func NewProjectsLocationsWorkloadIdentityPoolsService(s *Service) *ProjectsLocationsWorkloadIdentityPoolsService { rs := &ProjectsLocationsWorkloadIdentityPoolsService{s: s} + rs.Namespaces = NewProjectsLocationsWorkloadIdentityPoolsNamespacesService(s) rs.Operations = NewProjectsLocationsWorkloadIdentityPoolsOperationsService(s) rs.Providers = NewProjectsLocationsWorkloadIdentityPoolsProvidersService(s) return rs @@ -337,11 +338,106 @@ func NewProjectsLocationsWorkloadIdentityPoolsService(s *Service) *ProjectsLocat type ProjectsLocationsWorkloadIdentityPoolsService struct { s *Service + Namespaces *ProjectsLocationsWorkloadIdentityPoolsNamespacesService + Operations *ProjectsLocationsWorkloadIdentityPoolsOperationsService Providers *ProjectsLocationsWorkloadIdentityPoolsProvidersService } +func NewProjectsLocationsWorkloadIdentityPoolsNamespacesService(s *Service) *ProjectsLocationsWorkloadIdentityPoolsNamespacesService { + rs := &ProjectsLocationsWorkloadIdentityPoolsNamespacesService{s: s} + rs.ManagedIdentities = NewProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesService(s) + rs.Operations = NewProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsService(s) + rs.WorkloadSources = NewProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesService(s) + return rs +} + +type ProjectsLocationsWorkloadIdentityPoolsNamespacesService struct { + s *Service + + ManagedIdentities *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesService + + Operations *ProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsService + + WorkloadSources *ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesService +} + +func NewProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesService(s *Service) *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesService { + rs := &ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesService{s: s} + rs.Operations = NewProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOperationsService(s) + rs.WorkloadSources = NewProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesService(s) + return rs +} + +type ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesService struct { + s *Service + + Operations *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOperationsService + + WorkloadSources *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesService +} + +func NewProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOperationsService(s *Service) *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOperationsService { + rs := &ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOperationsService{s: s} + return rs +} + +type ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOperationsService struct { + s *Service +} + +func NewProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesService(s *Service) *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesService { + rs := &ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesService{s: s} + rs.Operations = NewProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesOperationsService(s) + return rs +} + +type ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesService struct { + s *Service + + Operations *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesOperationsService +} + +func NewProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesOperationsService(s *Service) *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesOperationsService { + rs := &ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesOperationsService{s: s} + return rs +} + +type ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesOperationsService struct { + s *Service +} + +func NewProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsService(s *Service) *ProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsService { + rs := &ProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsService{s: s} + return rs +} + +type ProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsService struct { + s *Service +} + +func NewProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesService(s *Service) *ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesService { + rs := &ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesService{s: s} + rs.Operations = NewProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOperationsService(s) + return rs +} + +type ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesService struct { + s *Service + + Operations *ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOperationsService +} + +func NewProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOperationsService(s *Service) *ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOperationsService { + rs := &ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOperationsService{s: s} + return rs +} + +type ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOperationsService struct { + s *Service +} + func NewProjectsLocationsWorkloadIdentityPoolsOperationsService(s *Service) *ProjectsLocationsWorkloadIdentityPoolsOperationsService { rs := &ProjectsLocationsWorkloadIdentityPoolsOperationsService{s: s} return rs @@ -1061,6 +1157,10 @@ type GoogleIamAdminV1WorkforcePoolProviderOidc struct { // the JWT issued by the identity provider. ClientId string `json:"clientId,omitempty"` + // ClientSecret: The optional client secret. Required to enable + // Authorization Code flow for web sign-in. + ClientSecret *GoogleIamAdminV1WorkforcePoolProviderOidcClientSecret `json:"clientSecret,omitempty"` + // IssuerUri: Required. The OIDC issuer URI. Must be a valid URI using // the 'https' scheme. IssuerUri string `json:"issuerUri,omitempty"` @@ -1093,9 +1193,81 @@ func (s *GoogleIamAdminV1WorkforcePoolProviderOidc) MarshalJSON() ([]byte, error return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleIamAdminV1WorkforcePoolProviderOidcClientSecret: Representation +// of a client secret configured for the OIDC provider. +type GoogleIamAdminV1WorkforcePoolProviderOidcClientSecret struct { + // Value: The value of the client secret. + Value *GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretValue `json:"value,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Value") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Value") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleIamAdminV1WorkforcePoolProviderOidcClientSecret) MarshalJSON() ([]byte, error) { + type NoMethod GoogleIamAdminV1WorkforcePoolProviderOidcClientSecret + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretValue: +// Representation of the value of the client secret. +type GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretValue struct { + // PlainText: Input only. The plain text of the client secret value. For + // security reasons, this field is only used for input and will never be + // populated in any response. + PlainText string `json:"plainText,omitempty"` + + // Thumbprint: Output only. A thumbprint to represent the current client + // secret value. + Thumbprint string `json:"thumbprint,omitempty"` + + // ForceSendFields is a list of field names (e.g. "PlainText") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "PlainText") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretValue) MarshalJSON() ([]byte, error) { + type NoMethod GoogleIamAdminV1WorkforcePoolProviderOidcClientSecretValue + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfig: Configuration // for web single sign-on for the OIDC provider. type GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfig struct { + // AdditionalScopes: Additional scopes to request for in the OIDC + // authentication request on top of scopes requested by default. By + // default, the `openid`, `profile` and `email` scopes that are + // supported by the identity provider are requested. Each additional + // scope may be at most 256 characters. A maximum of 10 additional + // scopes may be configured. + AdditionalScopes []string `json:"additionalScopes,omitempty"` + // AssertionClaimsBehavior: Required. The behavior for how OIDC Claims // are included in the `assertion` object used for attribute mapping and // attribute condition. @@ -1103,6 +1275,11 @@ type GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfig struct { // Possible values: // "ASSERTION_CLAIMS_BEHAVIOR_UNSPECIFIED" - No assertion claims // behavior specified. + // "MERGE_USER_INFO_OVER_ID_TOKEN_CLAIMS" - Merge the UserInfo + // Endpoint Claims with ID Token Claims, preferring UserInfo Claim + // Values for the same Claim Name. Only possible for flows granting an + // Access Token, which comprise only the Authorization Code Flow at the + // moment. // "ONLY_ID_TOKEN_CLAIMS" - Only include ID Token Claims. AssertionClaimsBehavior string `json:"assertionClaimsBehavior,omitempty"` @@ -1111,23 +1288,24 @@ type GoogleIamAdminV1WorkforcePoolProviderOidcWebSsoConfig struct { // // Possible values: // "RESPONSE_TYPE_UNSPECIFIED" - No Response Type specified. + // "CODE" - The `response_type=code` selection uses the Authorization + // Code Flow for web sign-in. Requires a configured client secret. // "ID_TOKEN" - The `response_type=id_token` selection uses the // Implicit Flow for web sign-in. ResponseType string `json:"responseType,omitempty"` - // ForceSendFields is a list of field names (e.g. - // "AssertionClaimsBehavior") to unconditionally include in API - // requests. By default, fields with empty or default values are omitted - // from API requests. However, any non-pointer, non-interface field - // appearing in ForceSendFields will be sent to the server regardless of - // whether the field is empty or not. This may be used to include empty - // fields in Patch requests. + // ForceSendFields is a list of field names (e.g. "AdditionalScopes") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "AssertionClaimsBehavior") - // to include in API requests with the JSON null value. By default, - // fields with empty values are omitted from API requests. However, any - // field with an empty value appearing in NullFields will be sent to the + // NullFields is a list of field names (e.g. "AdditionalScopes") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the // server as null. It is an error if a field in this list has a // non-empty value. This may be used to include null fields in Patch // requests. @@ -2359,12 +2537,13 @@ type Role struct { // when bound in an IAM policy. IncludedPermissions []string `json:"includedPermissions,omitempty"` - // Name: The name of the role. When Role is used in CreateRole, the role - // name must not be set. When Role is used in output and other input - // such as UpdateRole, the role name is the complete path, e.g., - // roles/logging.viewer for predefined roles and - // organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom - // roles. + // Name: The name of the role. When `Role` is used in `CreateRole`, the + // role name must not be set. When `Role` is used in output and other + // input such as `UpdateRole`, the role name is the complete path. For + // example, `roles/logging.viewer` for predefined roles, + // `organizations/{ORGANIZATION_ID}/roles/my-role` for + // organization-level custom roles, and + // `projects/{PROJECT_ID}/roles/my-role` for project-level custom roles. Name string `json:"name,omitempty"` // Stage: The current launch stage of the role. If the `ALPHA` launch @@ -3376,6 +3555,25 @@ type WorkloadIdentityPool struct { // characters. DisplayName string `json:"displayName,omitempty"` + // IdentityMode: Immutable. The identity mode of the pool. + // + // Possible values: + // "IDENTITY_MODE_UNSPECIFIED" - Existing pools will be in this mode. + // For existing worklod identity pools created through the public API, + // they will act as if they are set to FEDERATION_ONLY. + // "FEDERATION_ONLY" - With FEDERATION_ONLY mode, providers can be + // created at the root level within the pool. Attribute mappings must + // specify a "google.subject" claim that specifies the identity of the + // federation workload. Namespace or any sub-namespace resources is not + // allowed with this mode. + // "TRUST_DOMAIN" - With TRUST_DOMAIN mode, providers can be created + // at the root level within the pool. Attribute mappings must specify + // the "google.namespace" and "google.workload_identifier" claims that, + // respectively, specify the namespace and individual sub-namespace + // identifier for the workload. Namespaces and sub-Namespace resources + // are allowed. + IdentityMode string `json:"identityMode,omitempty"` + // Name: Output only. The resource name of the pool. Name string `json:"name,omitempty"` @@ -10133,6 +10331,598 @@ func (c *ProjectsLocationsWorkloadIdentityPoolsUndeleteCall) Do(opts ...googleap } +// method id "iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.operations.get": + +type ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOperationsGetCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// Get: 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. +// +// - name: The name of the operation resource. +func (r *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOperationsService) Get(name string) *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOperationsGetCall { + c := &ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOperationsGetCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOperationsGetCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOperationsGetCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOperationsGetCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOperationsGetCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.operations.get" call. +// Exactly one of *Operation or error will be non-nil. Any non-2xx +// status code is an error. Response headers are in either +// *Operation.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified +// to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Operation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "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}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}/operations/{operationsId}", + // "httpMethod": "GET", + // "id": "iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.operations.get", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "The name of the operation resource.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+/operations/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1/{+name}", + // "response": { + // "$ref": "Operation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.workloadSources.operations.get": + +type ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesOperationsGetCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// Get: 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. +// +// - name: The name of the operation resource. +func (r *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesOperationsService) Get(name string) *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesOperationsGetCall { + c := &ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesOperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesOperationsGetCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesOperationsGetCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesOperationsGetCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesOperationsGetCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesOperationsGetCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.workloadSources.operations.get" call. +// Exactly one of *Operation or error will be non-nil. Any non-2xx +// status code is an error. Response headers are in either +// *Operation.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified +// to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesManagedIdentitiesWorkloadSourcesOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Operation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "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}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/managedIdentities/{managedIdentitiesId}/workloadSources/{workloadSourcesId}/operations/{operationsId}", + // "httpMethod": "GET", + // "id": "iam.projects.locations.workloadIdentityPools.namespaces.managedIdentities.workloadSources.operations.get", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "The name of the operation resource.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/managedIdentities/[^/]+/workloadSources/[^/]+/operations/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1/{+name}", + // "response": { + // "$ref": "Operation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "iam.projects.locations.workloadIdentityPools.namespaces.operations.get": + +type ProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsGetCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// Get: 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. +// +// - name: The name of the operation resource. +func (r *ProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsService) Get(name string) *ProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsGetCall { + c := &ProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsGetCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsGetCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsGetCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsGetCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsGetCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "iam.projects.locations.workloadIdentityPools.namespaces.operations.get" call. +// Exactly one of *Operation or error will be non-nil. Any non-2xx +// status code is an error. Response headers are in either +// *Operation.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified +// to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Operation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "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}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/operations/{operationsId}", + // "httpMethod": "GET", + // "id": "iam.projects.locations.workloadIdentityPools.namespaces.operations.get", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "The name of the operation resource.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/operations/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1/{+name}", + // "response": { + // "$ref": "Operation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + +// method id "iam.projects.locations.workloadIdentityPools.namespaces.workloadSources.operations.get": + +type ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOperationsGetCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// Get: 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. +// +// - name: The name of the operation resource. +func (r *ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOperationsService) Get(name string) *ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOperationsGetCall { + c := &ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOperationsGetCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOperationsGetCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOperationsGetCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOperationsGetCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOperationsGetCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "iam.projects.locations.workloadIdentityPools.namespaces.workloadSources.operations.get" call. +// Exactly one of *Operation or error will be non-nil. Any non-2xx +// status code is an error. Response headers are in either +// *Operation.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified +// to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsWorkloadIdentityPoolsNamespacesWorkloadSourcesOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Operation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "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}/workloadIdentityPools/{workloadIdentityPoolsId}/namespaces/{namespacesId}/workloadSources/{workloadSourcesId}/operations/{operationsId}", + // "httpMethod": "GET", + // "id": "iam.projects.locations.workloadIdentityPools.namespaces.workloadSources.operations.get", + // "parameterOrder": [ + // "name" + // ], + // "parameters": { + // "name": { + // "description": "The name of the operation resource.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+/namespaces/[^/]+/workloadSources/[^/]+/operations/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1/{+name}", + // "response": { + // "$ref": "Operation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + // method id "iam.projects.locations.workloadIdentityPools.operations.get": type ProjectsLocationsWorkloadIdentityPoolsOperationsGetCall struct { diff --git a/sasportal/v1alpha1/sasportal-api.json b/sasportal/v1alpha1/sasportal-api.json index 656227e7105..545d01e3da1 100644 --- a/sasportal/v1alpha1/sasportal-api.json +++ b/sasportal/v1alpha1/sasportal-api.json @@ -109,6 +109,22 @@ "resources": { "customers": { "methods": { + "checkHasProvisionedDeployment": { + "description": "Checks whether a SAS deployment for the authentication context exists.", + "flatPath": "v1alpha1/customers:checkHasProvisionedDeployment", + "httpMethod": "GET", + "id": "sasportal.customers.checkHasProvisionedDeployment", + "parameterOrder": [], + "parameters": {}, + "path": "v1alpha1/customers:checkHasProvisionedDeployment", + "response": { + "$ref": "SasPortalCheckHasProvisionedDeploymentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sasportal" + ] + }, "get": { "description": "Returns a requested customer.", "flatPath": "v1alpha1/customers/{customersId}", @@ -163,6 +179,25 @@ "https://www.googleapis.com/auth/sasportal" ] }, + "migrateOrganization": { + "description": "Migrates a SAS organization to the cloud. This will create GCP projects for each deployment and associate them. The SAS Organization is linked to the gcp project that called the command. go/sas-legacy-customer-migration", + "flatPath": "v1alpha1/customers:migrateOrganization", + "httpMethod": "POST", + "id": "sasportal.customers.migrateOrganization", + "parameterOrder": [], + "parameters": {}, + "path": "v1alpha1/customers:migrateOrganization", + "request": { + "$ref": "SasPortalMigrateOrganizationRequest" + }, + "response": { + "$ref": "SasPortalOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sasportal" + ] + }, "patch": { "description": "Updates an existing customer.", "flatPath": "v1alpha1/customers/{customersId}", @@ -2582,7 +2617,7 @@ } } }, - "revision": "20230606", + "revision": "20230625", "rootUrl": "https://sasportal.googleapis.com/", "schemas": { "SasPortalAssignment": { @@ -2619,6 +2654,17 @@ }, "type": "object" }, + "SasPortalCheckHasProvisionedDeploymentResponse": { + "description": "Response for [CheckHasProvisionedDeployment]. [spectrum.sas.portal.v1alpha1.Provisioning.CheckHasProvisionedDeployment].", + "id": "SasPortalCheckHasProvisionedDeploymentResponse", + "properties": { + "hasProvisionedDeployment": { + "description": "Whether a SAS deployment for the authentication context exists.", + "type": "boolean" + } + }, + "type": "object" + }, "SasPortalCreateSignedDeviceRequest": { "description": "Request for CreateSignedDevice.", "id": "SasPortalCreateSignedDeviceRequest", @@ -2688,6 +2734,21 @@ }, "type": "object" }, + "SasPortalDeploymentAssociation": { + "description": "Association between a gcp project and a SAS user id.", + "id": "SasPortalDeploymentAssociation", + "properties": { + "gcpProjectId": { + "description": "GCP project id of the associated project.", + "type": "string" + }, + "userId": { + "description": "User id of the deployment.", + "type": "string" + } + }, + "type": "object" + }, "SasPortalDevice": { "id": "SasPortalDevice", "properties": { @@ -3243,6 +3304,58 @@ }, "type": "object" }, + "SasPortalMigrateOrganizationMetadata": { + "description": "Long-running operation metadata message returned by the MigrateOrganization.", + "id": "SasPortalMigrateOrganizationMetadata", + "properties": { + "operationState": { + "description": "Output only. Current operation state", + "enum": [ + "OPERATION_STATE_UNSPECIFIED", + "OPERATION_STATE_PENDING", + "OPERATION_STATE_RUNNING", + "OPERATION_STATE_SUCCEEDED", + "OPERATION_STATE_FAILED" + ], + "enumDescriptions": [ + "Unspecified.", + "Pending (Not started).", + "In-progress.", + "Done successfully.", + "Done with errors." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "SasPortalMigrateOrganizationRequest": { + "description": "Request for [MigrateOrganization]. [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. GCP Project, Organization Info, and caller's GAIA ID should be retrieved from the RPC handler, and used to check authorization on SAS Portal organization and to create GCP Projects.", + "id": "SasPortalMigrateOrganizationRequest", + "properties": { + "organizationId": { + "description": "Required. Id of the SAS organization to be migrated.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "SasPortalMigrateOrganizationResponse": { + "description": "Response for [MigrateOrganization]. [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization].", + "id": "SasPortalMigrateOrganizationResponse", + "properties": { + "deploymentAssociation": { + "description": "Optional. A list of deployment association that were created for the migration, or current associations if they already exist.", + "items": { + "$ref": "SasPortalDeploymentAssociation" + }, + "type": "array" + } + }, + "type": "object" + }, "SasPortalMoveDeploymentRequest": { "description": "Request for MoveDeployment.", "id": "SasPortalMoveDeploymentRequest", diff --git a/sasportal/v1alpha1/sasportal-gen.go b/sasportal/v1alpha1/sasportal-gen.go index 04223797024..7945b32169b 100644 --- a/sasportal/v1alpha1/sasportal-gen.go +++ b/sasportal/v1alpha1/sasportal-gen.go @@ -464,6 +464,44 @@ func (s *SasPortalChannelWithScore) UnmarshalJSON(data []byte) error { return nil } +// SasPortalCheckHasProvisionedDeploymentResponse: Response for +// [CheckHasProvisionedDeployment]. +// [spectrum.sas.portal.v1alpha1.Provisioning.CheckHasProvisionedDeployme +// nt]. +type SasPortalCheckHasProvisionedDeploymentResponse struct { + // HasProvisionedDeployment: Whether a SAS deployment for the + // authentication context exists. + HasProvisionedDeployment bool `json:"hasProvisionedDeployment,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. + // "HasProvisionedDeployment") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "HasProvisionedDeployment") + // to include in API requests with the JSON null value. By default, + // fields with empty values are omitted from API requests. However, any + // field with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *SasPortalCheckHasProvisionedDeploymentResponse) MarshalJSON() ([]byte, error) { + type NoMethod SasPortalCheckHasProvisionedDeploymentResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // SasPortalCreateSignedDeviceRequest: Request for CreateSignedDevice. type SasPortalCreateSignedDeviceRequest struct { // EncodedDevice: Required. JSON Web Token signed using a CPI private @@ -580,6 +618,38 @@ func (s *SasPortalDeployment) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// SasPortalDeploymentAssociation: Association between a gcp project and +// a SAS user id. +type SasPortalDeploymentAssociation struct { + // GcpProjectId: GCP project id of the associated project. + GcpProjectId string `json:"gcpProjectId,omitempty"` + + // UserId: User id of the deployment. + UserId string `json:"userId,omitempty"` + + // ForceSendFields is a list of field names (e.g. "GcpProjectId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "GcpProjectId") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *SasPortalDeploymentAssociation) MarshalJSON() ([]byte, error) { + type NoMethod SasPortalDeploymentAssociation + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + type SasPortalDevice struct { // ActiveConfig: Output only. Current configuration of the device as // registered to the SAS. @@ -1401,6 +1471,111 @@ func (s *SasPortalListNodesResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// SasPortalMigrateOrganizationMetadata: Long-running operation metadata +// message returned by the MigrateOrganization. +type SasPortalMigrateOrganizationMetadata struct { + // OperationState: Output only. Current operation state + // + // Possible values: + // "OPERATION_STATE_UNSPECIFIED" - Unspecified. + // "OPERATION_STATE_PENDING" - Pending (Not started). + // "OPERATION_STATE_RUNNING" - In-progress. + // "OPERATION_STATE_SUCCEEDED" - Done successfully. + // "OPERATION_STATE_FAILED" - Done with errors. + OperationState string `json:"operationState,omitempty"` + + // ForceSendFields is a list of field names (e.g. "OperationState") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "OperationState") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *SasPortalMigrateOrganizationMetadata) MarshalJSON() ([]byte, error) { + type NoMethod SasPortalMigrateOrganizationMetadata + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// SasPortalMigrateOrganizationRequest: Request for +// [MigrateOrganization]. +// [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. GCP +// Project, Organization Info, and caller's GAIA ID should be retrieved +// from the RPC handler, and used to check authorization on SAS Portal +// organization and to create GCP Projects. +type SasPortalMigrateOrganizationRequest struct { + // OrganizationId: Required. Id of the SAS organization to be migrated. + OrganizationId int64 `json:"organizationId,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "OrganizationId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "OrganizationId") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *SasPortalMigrateOrganizationRequest) MarshalJSON() ([]byte, error) { + type NoMethod SasPortalMigrateOrganizationRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// SasPortalMigrateOrganizationResponse: Response for +// [MigrateOrganization]. +// [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. +type SasPortalMigrateOrganizationResponse struct { + // DeploymentAssociation: Optional. A list of deployment association + // that were created for the migration, or current associations if they + // already exist. + DeploymentAssociation []*SasPortalDeploymentAssociation `json:"deploymentAssociation,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "DeploymentAssociation") to unconditionally include in API requests. + // By default, fields with empty or default values are omitted from API + // requests. However, any non-pointer, non-interface field appearing in + // ForceSendFields will be sent to the server regardless of whether the + // field is empty or not. This may be used to include empty fields in + // Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DeploymentAssociation") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *SasPortalMigrateOrganizationResponse) MarshalJSON() ([]byte, error) { + type NoMethod SasPortalMigrateOrganizationResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // SasPortalMoveDeploymentRequest: Request for MoveDeployment. type SasPortalMoveDeploymentRequest struct { // Destination: Required. The name of the new parent resource node or @@ -2027,6 +2202,139 @@ type SasPortalValidateInstallerResponse struct { googleapi.ServerResponse `json:"-"` } +// method id "sasportal.customers.checkHasProvisionedDeployment": + +type CustomersCheckHasProvisionedDeploymentCall struct { + s *Service + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// CheckHasProvisionedDeployment: Checks whether a SAS deployment for +// the authentication context exists. +func (r *CustomersService) CheckHasProvisionedDeployment() *CustomersCheckHasProvisionedDeploymentCall { + c := &CustomersCheckHasProvisionedDeploymentCall{s: r.s, urlParams_: make(gensupport.URLParams)} + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *CustomersCheckHasProvisionedDeploymentCall) Fields(s ...googleapi.Field) *CustomersCheckHasProvisionedDeploymentCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *CustomersCheckHasProvisionedDeploymentCall) IfNoneMatch(entityTag string) *CustomersCheckHasProvisionedDeploymentCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *CustomersCheckHasProvisionedDeploymentCall) Context(ctx context.Context) *CustomersCheckHasProvisionedDeploymentCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *CustomersCheckHasProvisionedDeploymentCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *CustomersCheckHasProvisionedDeploymentCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha1/customers:checkHasProvisionedDeployment") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "sasportal.customers.checkHasProvisionedDeployment" call. +// Exactly one of *SasPortalCheckHasProvisionedDeploymentResponse or +// error will be non-nil. Any non-2xx status code is an error. Response +// headers are in either +// *SasPortalCheckHasProvisionedDeploymentResponse.ServerResponse.Header +// or (if a response was returned at all) in +// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check +// whether the returned error was because http.StatusNotModified was +// returned. +func (c *CustomersCheckHasProvisionedDeploymentCall) Do(opts ...googleapi.CallOption) (*SasPortalCheckHasProvisionedDeploymentResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &SasPortalCheckHasProvisionedDeploymentResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Checks whether a SAS deployment for the authentication context exists.", + // "flatPath": "v1alpha1/customers:checkHasProvisionedDeployment", + // "httpMethod": "GET", + // "id": "sasportal.customers.checkHasProvisionedDeployment", + // "parameterOrder": [], + // "parameters": {}, + // "path": "v1alpha1/customers:checkHasProvisionedDeployment", + // "response": { + // "$ref": "SasPortalCheckHasProvisionedDeploymentResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform", + // "https://www.googleapis.com/auth/sasportal" + // ] + // } + +} + // method id "sasportal.customers.get": type CustomersGetCall struct { @@ -2352,6 +2660,135 @@ func (c *CustomersListCall) Pages(ctx context.Context, f func(*SasPortalListCust } } +// method id "sasportal.customers.migrateOrganization": + +type CustomersMigrateOrganizationCall struct { + s *Service + sasportalmigrateorganizationrequest *SasPortalMigrateOrganizationRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// MigrateOrganization: Migrates a SAS organization to the cloud. This +// will create GCP projects for each deployment and associate them. The +// SAS Organization is linked to the gcp project that called the +// command. go/sas-legacy-customer-migration +func (r *CustomersService) MigrateOrganization(sasportalmigrateorganizationrequest *SasPortalMigrateOrganizationRequest) *CustomersMigrateOrganizationCall { + c := &CustomersMigrateOrganizationCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.sasportalmigrateorganizationrequest = sasportalmigrateorganizationrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *CustomersMigrateOrganizationCall) Fields(s ...googleapi.Field) *CustomersMigrateOrganizationCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *CustomersMigrateOrganizationCall) Context(ctx context.Context) *CustomersMigrateOrganizationCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *CustomersMigrateOrganizationCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *CustomersMigrateOrganizationCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.sasportalmigrateorganizationrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha1/customers:migrateOrganization") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "sasportal.customers.migrateOrganization" call. +// Exactly one of *SasPortalOperation or error will be non-nil. Any +// non-2xx status code is an error. Response headers are in either +// *SasPortalOperation.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *CustomersMigrateOrganizationCall) Do(opts ...googleapi.CallOption) (*SasPortalOperation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &SasPortalOperation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Migrates a SAS organization to the cloud. This will create GCP projects for each deployment and associate them. The SAS Organization is linked to the gcp project that called the command. go/sas-legacy-customer-migration", + // "flatPath": "v1alpha1/customers:migrateOrganization", + // "httpMethod": "POST", + // "id": "sasportal.customers.migrateOrganization", + // "parameterOrder": [], + // "parameters": {}, + // "path": "v1alpha1/customers:migrateOrganization", + // "request": { + // "$ref": "SasPortalMigrateOrganizationRequest" + // }, + // "response": { + // "$ref": "SasPortalOperation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-platform", + // "https://www.googleapis.com/auth/sasportal" + // ] + // } + +} + // method id "sasportal.customers.patch": type CustomersPatchCall struct { diff --git a/searchads360/v0/searchads360-api.json b/searchads360/v0/searchads360-api.json index c05106c26f7..7b97bba024f 100644 --- a/searchads360/v0/searchads360-api.json +++ b/searchads360/v0/searchads360-api.json @@ -106,6 +106,23 @@ "protocol": "rest", "resources": { "customers": { + "methods": { + "listAccessibleCustomers": { + "description": "Returns resource names of customers directly accessible by the user authenticating the call. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()", + "flatPath": "v0/customers:listAccessibleCustomers", + "httpMethod": "GET", + "id": "searchads360.customers.listAccessibleCustomers", + "parameterOrder": [], + "parameters": {}, + "path": "v0/customers:listAccessibleCustomers", + "response": { + "$ref": "GoogleAdsSearchads360V0Services__ListAccessibleCustomersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/doubleclicksearch" + ] + } + }, "resources": { "customColumns": { "methods": { @@ -243,7 +260,7 @@ } } }, - "revision": "20230504", + "revision": "20230625", "rootUrl": "https://searchads360.googleapis.com/", "schemas": { "GoogleAdsSearchads360V0Common__AgeRangeInfo": { @@ -959,6 +976,33 @@ }, "type": "object" }, + "GoogleAdsSearchads360V0Common__MobileAppAsset": { + "description": "An asset representing a mobile app.", + "id": "GoogleAdsSearchads360V0Common__MobileAppAsset", + "properties": { + "appId": { + "description": "Required. A string that uniquely identifies a mobile application. It should just contain the platform native id, like \"com.android.ebay\" for Android or \"12345689\" for iOS.", + "type": "string" + }, + "appStore": { + "description": "Required. The application store that distributes this specific app.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "APPLE_APP_STORE", + "GOOGLE_APP_STORE" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "Mobile app vendor for Apple app store.", + "Mobile app vendor for Google app store." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleAdsSearchads360V0Common__PercentCpc": { "description": "A bidding strategy where bids are a fraction of the advertised price for some good or service.", "id": "GoogleAdsSearchads360V0Common__PercentCpc", @@ -1108,6 +1152,30 @@ "description": "Segment only fields.", "id": "GoogleAdsSearchads360V0Common__Segments", "properties": { + "adNetworkType": { + "description": "Ad network type.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "SEARCH", + "SEARCH_PARTNERS", + "CONTENT", + "YOUTUBE_SEARCH", + "YOUTUBE_WATCH", + "MIXED" + ], + "enumDescriptions": [ + "Not specified.", + "The value is unknown in this version.", + "Google search.", + "Search partners.", + "Display Network.", + "YouTube Search.", + "YouTube Videos", + "Cross-network." + ], + "type": "string" + }, "conversionAction": { "description": "Resource name of the conversion action.", "type": "string" @@ -1645,6 +1713,22 @@ ], "type": "string" }, + "customColumnError": { + "description": "The reasons for the custom column error", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "CUSTOM_COLUMN_NOT_FOUND", + "CUSTOM_COLUMN_NOT_AVAILABLE" + ], + "enumDescriptions": [ + "Enum unspecified.", + "The received error code is not known in this version.", + "The custom column has not been found.", + "The custom column is not available." + ], + "type": "string" + }, "dateError": { "description": "The reasons for the date error", "enum": [ @@ -3133,6 +3217,176 @@ }, "type": "object" }, + "GoogleAdsSearchads360V0Resources__Asset": { + "description": "Asset is a part of an ad which can be shared across multiple ads. It can be an image (ImageAsset), a video (YoutubeVideoAsset), etc. Assets are immutable and cannot be removed. To stop an asset from serving, remove the asset from the entity that is using it.", + "id": "GoogleAdsSearchads360V0Resources__Asset", + "properties": { + "creationTime": { + "description": "Output only. The timestamp when this asset was created. The timestamp is in the customer's time zone and in \"yyyy-MM-dd HH:mm:ss\" format.", + "readOnly": true, + "type": "string" + }, + "engineStatus": { + "description": "Output only. The Engine Status for an asset.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "SERVING", + "SERVING_LIMITED", + "DISAPPROVED", + "DISABLED", + "REMOVED" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "The asset is active.", + "The asset is active limited.", + "The asset is disapproved (not eligible).", + "The asset is inactive (pending).", + "The asset has been removed." + ], + "readOnly": true, + "type": "string" + }, + "finalUrls": { + "description": "A list of possible final URLs after all cross domain redirects.", + "items": { + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "Output only. The ID of the asset.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "lastModifiedTime": { + "description": "Output only. The datetime when this asset was last modified. The datetime is in the customer's time zone and in \"yyyy-MM-dd HH:mm:ss.ssssss\" format.", + "readOnly": true, + "type": "string" + }, + "mobileAppAsset": { + "$ref": "GoogleAdsSearchads360V0Common__MobileAppAsset", + "description": "A mobile app asset." + }, + "resourceName": { + "description": "Immutable. The resource name of the asset. Asset resource names have the form: `customers/{customer_id}/assets/{asset_id}`", + "type": "string" + }, + "status": { + "description": "Output only. The status of the asset.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "ENABLED", + "REMOVED", + "ARCHIVED", + "PENDING_SYSTEM_GENERATED" + ], + "enumDescriptions": [ + "The status has not been specified.", + "The received value is not known in this version. This is a response-only value.", + "The asset is enabled.", + "The asset is removed.", + "The asset is archived.", + "The asset is system generated pending user review." + ], + "readOnly": true, + "type": "string" + }, + "trackingUrlTemplate": { + "description": "URL template for constructing a tracking URL.", + "type": "string" + }, + "type": { + "description": "Output only. Type of the asset.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "YOUTUBE_VIDEO", + "MEDIA_BUNDLE", + "IMAGE", + "TEXT", + "LEAD_FORM", + "BOOK_ON_GOOGLE", + "PROMOTION", + "CALLOUT", + "STRUCTURED_SNIPPET", + "SITELINK", + "PAGE_FEED", + "DYNAMIC_EDUCATION", + "MOBILE_APP", + "HOTEL_CALLOUT", + "CALL", + "PRICE", + "CALL_TO_ACTION", + "DYNAMIC_REAL_ESTATE", + "DYNAMIC_CUSTOM", + "DYNAMIC_HOTELS_AND_RENTALS", + "DYNAMIC_FLIGHTS", + "DISCOVERY_CAROUSEL_CARD", + "DYNAMIC_TRAVEL", + "DYNAMIC_LOCAL", + "DYNAMIC_JOBS", + "LOCATION", + "HOTEL_PROPERTY" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "YouTube video asset.", + "Media bundle asset.", + "Image asset.", + "Text asset.", + "Lead form asset.", + "Book on Google asset.", + "Promotion asset.", + "Callout asset.", + "Structured Snippet asset.", + "Sitelink asset.", + "Page Feed asset.", + "Dynamic Education asset.", + "Mobile app asset.", + "Hotel callout asset.", + "Call asset.", + "Price asset.", + "Call to action asset.", + "Dynamic real estate asset.", + "Dynamic custom asset.", + "Dynamic hotels and rentals asset.", + "Dynamic flights asset.", + "Discovery Carousel Card asset.", + "Dynamic travel asset.", + "Dynamic local asset.", + "Dynamic jobs asset.", + "Location asset.", + "Hotel property asset." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Resources__AssetSet": { + "description": "An asset set representing a collection of assets. Use AssetSetAsset to link an asset to the asset set.", + "id": "GoogleAdsSearchads360V0Resources__AssetSet", + "properties": { + "id": { + "description": "Output only. The ID of the asset set.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "resourceName": { + "description": "Immutable. The resource name of the asset set. Asset set resource names have the form: `customers/{customer_id}/assetSets/{asset_set_id}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleAdsSearchads360V0Resources__BiddingStrategy": { "description": "A bidding strategy.", "id": "GoogleAdsSearchads360V0Resources__BiddingStrategy", @@ -4194,7 +4448,11 @@ "SMART_CAMPAIGN_MAP_DIRECTIONS", "SMART_CAMPAIGN_TRACKED_CALLS", "STORE_VISITS", - "WEBPAGE_CODELESS" + "WEBPAGE_CODELESS", + "UNIVERSAL_ANALYTICS_GOAL", + "UNIVERSAL_ANALYTICS_TRANSACTION", + "GOOGLE_ANALYTICS_4_CUSTOM", + "GOOGLE_ANALYTICS_4_PURCHASE" ], "enumDescriptions": [ "Not specified.", @@ -4234,7 +4492,11 @@ "The user requests directions to a business location within Google Maps. Smart campaign only. Read only.", "Call conversions that occur on Smart campaign Ads with call tracking setup, using Smart campaign custom criteria. Read only.", "Conversions that occur when a user visits an advertiser's retail store. Read only.", - "Conversions created from website events (such as form submissions or page loads), that don't use individually coded event snippets." + "Conversions created from website events (such as form submissions or page loads), that don't use individually coded event snippets.", + "Conversions that come from linked Universal Analytics goals.", + "Conversions that come from linked Universal Analytics transactions.", + "Conversions that come from linked Google Analytics 4 custom event conversions.", + "Conversions that come from linked Google Analytics 4 purchase conversions." ], "type": "string" }, @@ -5000,6 +5262,20 @@ }, "type": "object" }, + "GoogleAdsSearchads360V0Services__ListAccessibleCustomersResponse": { + "description": "Response message for CustomerService.ListAccessibleCustomers.", + "id": "GoogleAdsSearchads360V0Services__ListAccessibleCustomersResponse", + "properties": { + "resourceNames": { + "description": "Resource name of customers directly accessible by the user authenticating the call.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleAdsSearchads360V0Services__ListCustomColumnsResponse": { "description": "Response message for fetching all custom columns associated with a customer.", "id": "GoogleAdsSearchads360V0Services__ListCustomColumnsResponse", @@ -5054,6 +5330,14 @@ "$ref": "GoogleAdsSearchads360V0Resources__AgeRangeView", "description": "The age range view referenced in the query." }, + "asset": { + "$ref": "GoogleAdsSearchads360V0Resources__Asset", + "description": "The asset referenced in the query." + }, + "assetSet": { + "$ref": "GoogleAdsSearchads360V0Resources__AssetSet", + "description": "The asset set referenced in the query." + }, "biddingStrategy": { "$ref": "GoogleAdsSearchads360V0Resources__BiddingStrategy", "description": "The bidding strategy referenced in the query." diff --git a/searchads360/v0/searchads360-gen.go b/searchads360/v0/searchads360-gen.go index 0500dcca483..b5f184aa76a 100644 --- a/searchads360/v0/searchads360-gen.go +++ b/searchads360/v0/searchads360-gen.go @@ -1257,6 +1257,48 @@ func (s *GoogleAdsSearchads360V0Common__Metrics) UnmarshalJSON(data []byte) erro return nil } +// GoogleAdsSearchads360V0Common__MobileAppAsset: An asset representing +// a mobile app. +type GoogleAdsSearchads360V0Common__MobileAppAsset struct { + // AppId: Required. A string that uniquely identifies a mobile + // application. It should just contain the platform native id, like + // "com.android.ebay" for Android or "12345689" for iOS. + AppId string `json:"appId,omitempty"` + + // AppStore: Required. The application store that distributes this + // specific app. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "APPLE_APP_STORE" - Mobile app vendor for Apple app store. + // "GOOGLE_APP_STORE" - Mobile app vendor for Google app store. + AppStore string `json:"appStore,omitempty"` + + // ForceSendFields is a list of field names (e.g. "AppId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "AppId") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Common__MobileAppAsset) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Common__MobileAppAsset + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleAdsSearchads360V0Common__PercentCpc: A bidding strategy where // bids are a fraction of the advertised price for some good or service. type GoogleAdsSearchads360V0Common__PercentCpc struct { @@ -1499,6 +1541,19 @@ func (s *GoogleAdsSearchads360V0Common__SearchAds360TextAdInfo) MarshalJSON() ([ // GoogleAdsSearchads360V0Common__Segments: Segment only fields. type GoogleAdsSearchads360V0Common__Segments struct { + // AdNetworkType: Ad network type. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - The value is unknown in this version. + // "SEARCH" - Google search. + // "SEARCH_PARTNERS" - Search partners. + // "CONTENT" - Display Network. + // "YOUTUBE_SEARCH" - YouTube Search. + // "YOUTUBE_WATCH" - YouTube Videos + // "MIXED" - Cross-network. + AdNetworkType string `json:"adNetworkType,omitempty"` + // ConversionAction: Resource name of the conversion action. ConversionAction string `json:"conversionAction,omitempty"` @@ -1602,7 +1657,7 @@ type GoogleAdsSearchads360V0Common__Segments struct { // Year: Year, formatted as yyyy. Year int64 `json:"year,omitempty"` - // ForceSendFields is a list of field names (e.g. "ConversionAction") to + // ForceSendFields is a list of field names (e.g. "AdNetworkType") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -1610,13 +1665,12 @@ type GoogleAdsSearchads360V0Common__Segments struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ConversionAction") to - // include in API requests with the JSON null value. By default, fields - // with empty values are omitted from API requests. However, any field - // with an empty value appearing in NullFields will be sent to the - // server as null. It is an error if a field in this list has a - // non-empty value. This may be used to include null fields in Patch - // requests. + // NullFields is a list of field names (e.g. "AdNetworkType") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` } @@ -2298,6 +2352,15 @@ type GoogleAdsSearchads360V0Errors__ErrorCode struct { // metrics queried. AuthorizationError string `json:"authorizationError,omitempty"` + // CustomColumnError: The reasons for the custom column error + // + // Possible values: + // "UNSPECIFIED" - Enum unspecified. + // "UNKNOWN" - The received error code is not known in this version. + // "CUSTOM_COLUMN_NOT_FOUND" - The custom column has not been found. + // "CUSTOM_COLUMN_NOT_AVAILABLE" - The custom column is not available. + CustomColumnError string `json:"customColumnError,omitempty"` + // DateError: The reasons for the date error // // Possible values: @@ -4123,6 +4186,159 @@ func (s *GoogleAdsSearchads360V0Resources__AgeRangeView) MarshalJSON() ([]byte, return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleAdsSearchads360V0Resources__Asset: Asset is a part of an ad +// which can be shared across multiple ads. It can be an image +// (ImageAsset), a video (YoutubeVideoAsset), etc. Assets are immutable +// and cannot be removed. To stop an asset from serving, remove the +// asset from the entity that is using it. +type GoogleAdsSearchads360V0Resources__Asset struct { + // CreationTime: Output only. The timestamp when this asset was created. + // The timestamp is in the customer's time zone and in "yyyy-MM-dd + // HH:mm:ss" format. + CreationTime string `json:"creationTime,omitempty"` + + // EngineStatus: Output only. The Engine Status for an asset. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "SERVING" - The asset is active. + // "SERVING_LIMITED" - The asset is active limited. + // "DISAPPROVED" - The asset is disapproved (not eligible). + // "DISABLED" - The asset is inactive (pending). + // "REMOVED" - The asset has been removed. + EngineStatus string `json:"engineStatus,omitempty"` + + // FinalUrls: A list of possible final URLs after all cross domain + // redirects. + FinalUrls []string `json:"finalUrls,omitempty"` + + // Id: Output only. The ID of the asset. + Id int64 `json:"id,omitempty,string"` + + // LastModifiedTime: Output only. The datetime when this asset was last + // modified. The datetime is in the customer's time zone and in + // "yyyy-MM-dd HH:mm:ss.ssssss" format. + LastModifiedTime string `json:"lastModifiedTime,omitempty"` + + // MobileAppAsset: A mobile app asset. + MobileAppAsset *GoogleAdsSearchads360V0Common__MobileAppAsset `json:"mobileAppAsset,omitempty"` + + // ResourceName: Immutable. The resource name of the asset. Asset + // resource names have the form: + // `customers/{customer_id}/assets/{asset_id}` + ResourceName string `json:"resourceName,omitempty"` + + // Status: Output only. The status of the asset. + // + // Possible values: + // "UNSPECIFIED" - The status has not been specified. + // "UNKNOWN" - The received value is not known in this version. This + // is a response-only value. + // "ENABLED" - The asset is enabled. + // "REMOVED" - The asset is removed. + // "ARCHIVED" - The asset is archived. + // "PENDING_SYSTEM_GENERATED" - The asset is system generated pending + // user review. + Status string `json:"status,omitempty"` + + // TrackingUrlTemplate: URL template for constructing a tracking URL. + TrackingUrlTemplate string `json:"trackingUrlTemplate,omitempty"` + + // Type: Output only. Type of the asset. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "YOUTUBE_VIDEO" - YouTube video asset. + // "MEDIA_BUNDLE" - Media bundle asset. + // "IMAGE" - Image asset. + // "TEXT" - Text asset. + // "LEAD_FORM" - Lead form asset. + // "BOOK_ON_GOOGLE" - Book on Google asset. + // "PROMOTION" - Promotion asset. + // "CALLOUT" - Callout asset. + // "STRUCTURED_SNIPPET" - Structured Snippet asset. + // "SITELINK" - Sitelink asset. + // "PAGE_FEED" - Page Feed asset. + // "DYNAMIC_EDUCATION" - Dynamic Education asset. + // "MOBILE_APP" - Mobile app asset. + // "HOTEL_CALLOUT" - Hotel callout asset. + // "CALL" - Call asset. + // "PRICE" - Price asset. + // "CALL_TO_ACTION" - Call to action asset. + // "DYNAMIC_REAL_ESTATE" - Dynamic real estate asset. + // "DYNAMIC_CUSTOM" - Dynamic custom asset. + // "DYNAMIC_HOTELS_AND_RENTALS" - Dynamic hotels and rentals asset. + // "DYNAMIC_FLIGHTS" - Dynamic flights asset. + // "DISCOVERY_CAROUSEL_CARD" - Discovery Carousel Card asset. + // "DYNAMIC_TRAVEL" - Dynamic travel asset. + // "DYNAMIC_LOCAL" - Dynamic local asset. + // "DYNAMIC_JOBS" - Dynamic jobs asset. + // "LOCATION" - Location asset. + // "HOTEL_PROPERTY" - Hotel property asset. + Type string `json:"type,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CreationTime") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CreationTime") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Resources__Asset) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Resources__Asset + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleAdsSearchads360V0Resources__AssetSet: An asset set representing +// a collection of assets. Use AssetSetAsset to link an asset to the +// asset set. +type GoogleAdsSearchads360V0Resources__AssetSet struct { + // Id: Output only. The ID of the asset set. + Id int64 `json:"id,omitempty,string"` + + // ResourceName: Immutable. The resource name of the asset set. Asset + // set resource names have the form: + // `customers/{customer_id}/assetSets/{asset_set_id}` + ResourceName string `json:"resourceName,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Id") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Id") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Resources__AssetSet) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Resources__AssetSet + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleAdsSearchads360V0Resources__BiddingStrategy: A bidding // strategy. type GoogleAdsSearchads360V0Resources__BiddingStrategy struct { @@ -5270,6 +5486,14 @@ type GoogleAdsSearchads360V0Resources__ConversionAction struct { // "WEBPAGE_CODELESS" - Conversions created from website events (such // as form submissions or page loads), that don't use individually coded // event snippets. + // "UNIVERSAL_ANALYTICS_GOAL" - Conversions that come from linked + // Universal Analytics goals. + // "UNIVERSAL_ANALYTICS_TRANSACTION" - Conversions that come from + // linked Universal Analytics transactions. + // "GOOGLE_ANALYTICS_4_CUSTOM" - Conversions that come from linked + // Google Analytics 4 custom event conversions. + // "GOOGLE_ANALYTICS_4_PURCHASE" - Conversions that come from linked + // Google Analytics 4 purchase conversions. Type string `json:"type,omitempty"` // ValueSettings: Settings related to the value for conversion events @@ -6246,6 +6470,40 @@ func (s *GoogleAdsSearchads360V0Services__CustomColumnHeader) MarshalJSON() ([]b return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleAdsSearchads360V0Services__ListAccessibleCustomersResponse: +// Response message for CustomerService.ListAccessibleCustomers. +type GoogleAdsSearchads360V0Services__ListAccessibleCustomersResponse struct { + // ResourceNames: Resource name of customers directly accessible by the + // user authenticating the call. + ResourceNames []string `json:"resourceNames,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "ResourceNames") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ResourceNames") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Services__ListAccessibleCustomersResponse) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Services__ListAccessibleCustomersResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleAdsSearchads360V0Services__ListCustomColumnsResponse: Response // message for fetching all custom columns associated with a customer. type GoogleAdsSearchads360V0Services__ListCustomColumnsResponse struct { @@ -6311,6 +6569,12 @@ type GoogleAdsSearchads360V0Services__SearchAds360Row struct { // AgeRangeView: The age range view referenced in the query. AgeRangeView *GoogleAdsSearchads360V0Resources__AgeRangeView `json:"ageRangeView,omitempty"` + // Asset: The asset referenced in the query. + Asset *GoogleAdsSearchads360V0Resources__Asset `json:"asset,omitempty"` + + // AssetSet: The asset set referenced in the query. + AssetSet *GoogleAdsSearchads360V0Resources__AssetSet `json:"assetSet,omitempty"` + // BiddingStrategy: The bidding strategy referenced in the query. BiddingStrategy *GoogleAdsSearchads360V0Resources__BiddingStrategy `json:"biddingStrategy,omitempty"` @@ -6604,6 +6868,141 @@ func (s *GoogleAdsSearchads360V0Services__SearchSearchAds360Response) MarshalJSO return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// method id "searchads360.customers.listAccessibleCustomers": + +type CustomersListAccessibleCustomersCall struct { + s *Service + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// ListAccessibleCustomers: Returns resource names of customers directly +// accessible by the user authenticating the call. List of thrown +// errors: AuthenticationError () [AuthorizationError]() HeaderError () +// [InternalError]() QuotaError () [RequestError]() +func (r *CustomersService) ListAccessibleCustomers() *CustomersListAccessibleCustomersCall { + c := &CustomersListAccessibleCustomersCall{s: r.s, urlParams_: make(gensupport.URLParams)} + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *CustomersListAccessibleCustomersCall) Fields(s ...googleapi.Field) *CustomersListAccessibleCustomersCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *CustomersListAccessibleCustomersCall) IfNoneMatch(entityTag string) *CustomersListAccessibleCustomersCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *CustomersListAccessibleCustomersCall) Context(ctx context.Context) *CustomersListAccessibleCustomersCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *CustomersListAccessibleCustomersCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *CustomersListAccessibleCustomersCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v0/customers:listAccessibleCustomers") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "searchads360.customers.listAccessibleCustomers" call. +// Exactly one of +// *GoogleAdsSearchads360V0Services__ListAccessibleCustomersResponse or +// error will be non-nil. Any non-2xx status code is an error. Response +// headers are in either +// *GoogleAdsSearchads360V0Services__ListAccessibleCustomersResponse.Serv +// erResponse.Header or (if a response was returned at all) in +// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check +// whether the returned error was because http.StatusNotModified was +// returned. +func (c *CustomersListAccessibleCustomersCall) Do(opts ...googleapi.CallOption) (*GoogleAdsSearchads360V0Services__ListAccessibleCustomersResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleAdsSearchads360V0Services__ListAccessibleCustomersResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Returns resource names of customers directly accessible by the user authenticating the call. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()", + // "flatPath": "v0/customers:listAccessibleCustomers", + // "httpMethod": "GET", + // "id": "searchads360.customers.listAccessibleCustomers", + // "parameterOrder": [], + // "parameters": {}, + // "path": "v0/customers:listAccessibleCustomers", + // "response": { + // "$ref": "GoogleAdsSearchads360V0Services__ListAccessibleCustomersResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/doubleclicksearch" + // ] + // } + +} + // method id "searchads360.customers.customColumns.get": type CustomersCustomColumnsGetCall struct { diff --git a/servicenetworking/v1/servicenetworking-api.json b/servicenetworking/v1/servicenetworking-api.json index 874a4b6f065..a3864ad66ed 100644 --- a/servicenetworking/v1/servicenetworking-api.json +++ b/servicenetworking/v1/servicenetworking-api.json @@ -865,7 +865,7 @@ } } }, - "revision": "20230611", + "revision": "20230626", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -2939,7 +2939,7 @@ "type": "string" }, "role": { - "description": "Required. Role to apply. Only allowlisted roles can be used at the specified granularity. The role must be one of the following: - 'roles/container.hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.securityAdmin' applied on the shared VPC host project", + "description": "Required. Role to apply. Only allowlisted roles can be used at the specified granularity. The role must be one of the following: - 'roles/container.hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.securityAdmin' applied on the shared VPC host project - 'roles/compute.networkAdmin' applied on the shared VPC host project - 'roles/compute.xpnAdmin' applied on the shared VPC host project - 'roles/dns.admin' applied on the shared VPC host project", "type": "string" } }, diff --git a/servicenetworking/v1/servicenetworking-gen.go b/servicenetworking/v1/servicenetworking-gen.go index 4bad62e4b8f..d23aaf6aa5c 100644 --- a/servicenetworking/v1/servicenetworking-gen.go +++ b/servicenetworking/v1/servicenetworking-gen.go @@ -4215,7 +4215,10 @@ type PolicyBinding struct { // the specified granularity. The role must be one of the following: - // 'roles/container.hostServiceAgentUser' applied on the shared VPC host // project - 'roles/compute.securityAdmin' applied on the shared VPC - // host project + // host project - 'roles/compute.networkAdmin' applied on the shared VPC + // host project - 'roles/compute.xpnAdmin' applied on the shared VPC + // host project - 'roles/dns.admin' applied on the shared VPC host + // project Role string `json:"role,omitempty"` // ForceSendFields is a list of field names (e.g. "Member") to diff --git a/servicenetworking/v1beta/servicenetworking-api.json b/servicenetworking/v1beta/servicenetworking-api.json index 0610c7e0bc0..99dc341d753 100644 --- a/servicenetworking/v1beta/servicenetworking-api.json +++ b/servicenetworking/v1beta/servicenetworking-api.json @@ -307,7 +307,7 @@ } } }, - "revision": "20230611", + "revision": "20230626", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -2189,7 +2189,7 @@ "type": "string" }, "role": { - "description": "Required. Role to apply. Only allowlisted roles can be used at the specified granularity. The role must be one of the following: - 'roles/container.hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.securityAdmin' applied on the shared VPC host project", + "description": "Required. Role to apply. Only allowlisted roles can be used at the specified granularity. The role must be one of the following: - 'roles/container.hostServiceAgentUser' applied on the shared VPC host project - 'roles/compute.securityAdmin' applied on the shared VPC host project - 'roles/compute.networkAdmin' applied on the shared VPC host project - 'roles/compute.xpnAdmin' applied on the shared VPC host project - 'roles/dns.admin' applied on the shared VPC host project", "type": "string" } }, diff --git a/servicenetworking/v1beta/servicenetworking-gen.go b/servicenetworking/v1beta/servicenetworking-gen.go index 1bd99e20339..a8b7d1f41e7 100644 --- a/servicenetworking/v1beta/servicenetworking-gen.go +++ b/servicenetworking/v1beta/servicenetworking-gen.go @@ -3712,7 +3712,10 @@ type PolicyBinding struct { // the specified granularity. The role must be one of the following: - // 'roles/container.hostServiceAgentUser' applied on the shared VPC host // project - 'roles/compute.securityAdmin' applied on the shared VPC - // host project + // host project - 'roles/compute.networkAdmin' applied on the shared VPC + // host project - 'roles/compute.xpnAdmin' applied on the shared VPC + // host project - 'roles/dns.admin' applied on the shared VPC host + // project Role string `json:"role,omitempty"` // ForceSendFields is a list of field names (e.g. "Member") to diff --git a/vault/v1/vault-api.json b/vault/v1/vault-api.json index 1a43194fee0..7dc4207bf78 100644 --- a/vault/v1/vault-api.json +++ b/vault/v1/vault-api.json @@ -1193,7 +1193,7 @@ } } }, - "revision": "20230405", + "revision": "20230626", "rootUrl": "https://vault.googleapis.com/", "schemas": { "AccountCount": { @@ -1354,7 +1354,7 @@ "id": "CloudStorageFile", "properties": { "bucketName": { - "description": "The name of the Cloud Storage bucket for the export file. You can use this value in the [Cloud Storage JSON or XML APIs](https://cloud.google.com/storage/docs/apis), but not to list the bucket contents. Instead, you can [get individual export files](https://cloud.google.com/storage/docs/json_api/v1/objects/get) by object name.", + "description": "The name of the Cloud Storage bucket for the export file. You can use this value in the Cloud Storage [JSON API](https://cloud.google.com/storage/docs/json_api) or [XML API](https://cloud.google.com/storage/docs/xml-api), but not to list the bucket contents. Instead, you can [get individual export files](https://cloud.google.com/storage/docs/json_api/v1/objects/get) by object name.", "type": "string" }, "md5Hash": { @@ -1362,7 +1362,7 @@ "type": "string" }, "objectName": { - "description": "The name of the Cloud Storage object for the export file. You can use this value in the [Cloud Storage JSON or XML APIs](https://cloud.google.com/storage/docs/apis).", + "description": "The name of the Cloud Storage object for the export file. You can use this value in the Cloud Storage [JSON API](https://cloud.google.com/storage/docs/json_api) or [XML API](https://cloud.google.com/storage/docs/xml-api).", "type": "string" }, "size": { diff --git a/vault/v1/vault-gen.go b/vault/v1/vault-gen.go index 6229b2145e7..e4ba2642df6 100644 --- a/vault/v1/vault-gen.go +++ b/vault/v1/vault-gen.go @@ -500,8 +500,9 @@ func (s *CloseMatterResponse) MarshalJSON() ([]byte, error) { // CloudStorageFile: The export file in Cloud Storage type CloudStorageFile struct { // BucketName: The name of the Cloud Storage bucket for the export file. - // You can use this value in the Cloud Storage JSON or XML APIs - // (https://cloud.google.com/storage/docs/apis), but not to list the + // You can use this value in the Cloud Storage JSON API + // (https://cloud.google.com/storage/docs/json_api) or XML API + // (https://cloud.google.com/storage/docs/xml-api), but not to list the // bucket contents. Instead, you can get individual export files // (https://cloud.google.com/storage/docs/json_api/v1/objects/get) by // object name. @@ -511,8 +512,9 @@ type CloudStorageFile struct { Md5Hash string `json:"md5Hash,omitempty"` // ObjectName: The name of the Cloud Storage object for the export file. - // You can use this value in the Cloud Storage JSON or XML APIs - // (https://cloud.google.com/storage/docs/apis). + // You can use this value in the Cloud Storage JSON API + // (https://cloud.google.com/storage/docs/json_api) or XML API + // (https://cloud.google.com/storage/docs/xml-api). ObjectName string `json:"objectName,omitempty"` // Size: The export file size.